Skip to main content
POST
/
api
/
notebooks
Upload a notebook to the caller's home prefix
curl --request POST \
  --url https://api.example.com/api/notebooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=<string>'
{
  "s3_key": "<string>",
  "owner": "<string>",
  "size_bytes": 123,
  "last_modified": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

multipart/form-data
​
file
string
required

The .ipynb file to upload.

Response

Notebook uploaded successfully

Lightweight view of a notebook on S3 for list endpoints.

​
s3_key
string
required

Object key under the notebooks bucket, e.g. 'home/kcowan/churn.ipynb'.

​
owner
string
required

Owner username extracted from the S3 path prefix.

​
size_bytes
integer
required

Size of the notebook in bytes.

​
last_modified
string<date-time>
required

S3 LastModified timestamp.