Attach a notebook reference to an app version

curl --request PUT \ --url https://api.example.com/api/app/versions/{version_id}/notebook \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "s3_key": "<string>" } '

{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "app_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "component_type": "<string>", "properties_json": "<string>", "created_by": "<string>", "created_date": "<unknown>", "updated_by": "<string>", "updated_date": "<unknown>" }

Authorizations

Authorization

string

header

required

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

Path Parameters

version_id

string<uuid>

required

Body

application/json

Request body for attaching a notebook reference to an app version.

s3_key

string

required

Notebook key under the caller's home/{username}/ prefix. Must end in .ipynb.

Response

Notebook reference attached successfully.

Response model for app component details.

string<uuid>

required

Unique ID of the app component.

app_version_id

string<uuid>

required

ID of the parent app version.

component_type

string

required

Type of component.

properties_json

string | null

JSON string with component metadata.

created_by

string | null

Username of the creator.

created_date

any | null

Component creation timestamp.

updated_by

string | null

Username of the last updater.

updated_date

any | null

Timestamp when the component was last updated.