Skip to main content
GET
/
workspaces
/
{workspace_id}
/
notebooks
List notebooks
curl --request GET \
  --url https://s-server-demo.siftd.ai/api/workspaces/{workspace_id}/notebooks \
  --header 'Authorization: Bearer <token>'
[
  {
    "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": "<unknown>",
            "tags": [
              "<string>"
            ]
          },
          "param_map": {},
          "payload": [
            123
          ],
          "tool": "<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

Query Parameters

​
org_id
string
required

Organization ID

​
name_regex
string

Regex to filter notebooks by name

​
limit
integer
default:100

Maximum number of items to return

​
offset
integer
default:0

Number of items to skip

​
fetch_contents
boolean
default:false

Include notebook content

Response

200 - application/json

OK

​
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