Skip to main content
POST
/
workspaces
/
{workspace_id}
/
notebooks
/
{notebook_id}
/
compile
Compile notebook
curl --request POST \
  --url https://s-server-demo.siftd.ai/api/workspaces/{workspace_id}/notebooks/{notebook_id}/compile \
  --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": "<unknown>",
          "tags": [
            "<string>"
          ]
        },
        "param_map": {},
        "payload": [
          123
        ],
        "tool": "<string>"
      }
    ]
  },
  "emit_to_stdout": true,
  "end_index": 123,
  "loop_id": "<string>",
  "request_id": "<string>",
  "start_index": 123
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.siftd.ai/llms.txt

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

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

​
runtime_id
string

Runtime ID

​
mode
string

Mode (edit or run)

​
phase
string

Phase (preprocess or compile)

Body

application/json

Compile request

​
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.

​
emit_to_stdout
boolean
​
end_index
integer
​
loop_id
string
​
request_id
string
​
start_index
integer

Response

OK