Get the notebooks bucket and the caller's home prefix

curl --request GET \
  --url https://api.example.com/api/notebooks/location \
  --header 'Authorization: Bearer <token>'

{
  "bucket": "<string>",
  "home_prefix": "<string>"
}

GET

api

notebooks

location

Get the notebooks bucket and the caller's home prefix

curl --request GET \
  --url https://api.example.com/api/notebooks/location \
  --header 'Authorization: Bearer <token>'

{
  "bucket": "<string>",
  "home_prefix": "<string>"
}

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Location returned successfully

Where the caller's notebooks live in S3 — drives UI hint text.

bucket

string

required

The notebooks S3 bucket name.

home_prefix

string

required

The caller's home prefix, e.g. 'users/{username}/'.

⌘I