Skip to main content
PUT
/
workspaces
/
{workspace_id}
/
notebooks
/
{notebook_id}
Update notebook
curl --request PUT \
  --url https://s-server-demo.siftd.ai:9800/api/workspaces/{workspace_id}/notebooks/{notebook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "content": {
    "metadata": {},
    "spin_cells": [
      {
        "cell_id": "<string>",
        "cxn_name": "<string>",
        "desc": "<string>",
        "loop_id": "<string>",
        "metadata": {
          "collapsed": true,
          "display_settings": {},
          "output_variable_name": "<string>",
          "scrolled": "<any>",
          "tags": [
            "<string>"
          ]
        },
        "param_map": {},
        "payload": [
          123
        ],
        "tool": "<string>"
      }
    ],
    "template_vars": [
      {
        "code": "<string>",
        "kind": "static",
        "name": "<string>",
        "possible_values": [
          "<string>"
        ],
        "value": "<string>",
        "var_id": "<string>"
      }
    ]
  },
  "created_time": "<string>",
  "description": "<string>",
  "name": "<string>",
  "notebook_id": "<string>",
  "owner_id": "<string>",
  "updated_time": "<string>"
}'
{
  "content": {
    "metadata": {},
    "spin_cells": [
      {
        "cell_id": "<string>",
        "cxn_name": "<string>",
        "desc": "<string>",
        "loop_id": "<string>",
        "metadata": {
          "collapsed": true,
          "display_settings": {},
          "output_variable_name": "<string>",
          "scrolled": "<any>",
          "tags": [
            "<string>"
          ]
        },
        "param_map": {},
        "payload": [
          123
        ],
        "tool": "<string>"
      }
    ],
    "template_vars": [
      {
        "code": "<string>",
        "kind": "static",
        "name": "<string>",
        "possible_values": [
          "<string>"
        ],
        "value": "<string>",
        "var_id": "<string>"
      }
    ]
  },
  "created_time": "<string>",
  "description": "<string>",
  "name": "<string>",
  "notebook_id": "<string>",
  "owner_id": "<string>",
  "updated_time": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspace_id
string
required

Workspace ID

​
notebook_id
string
required

Notebook ID

Query Parameters

​
org_id
string
required

Organization ID

Body

application/json

Notebook object

A notebook within a workspace. A notebook contains cells which can be executed.

​
content
object

The content of a notebook. JSON representation of a Spin notebook. When a notebook is stored as a file, this is the content of the file.

​
created_time
string
​
description
string
​
name
string
​
notebook_id
string
​
owner_id
string
​
updated_time
string

Response

200 - application/json

OK

A notebook within a workspace. A notebook contains cells which can be executed.

​
content
object

The content of a notebook. JSON representation of a Spin notebook. When a notebook is stored as a file, this is the content of the file.

​
created_time
string
​
description
string
​
name
string
​
notebook_id
string
​
owner_id
string
​
updated_time
string
⌘I