latestOpenAPI 3.1.02026-08-204489152.5 KB

726970fd2992

Runs

Run a notebook

post/runs

Request body

notebookIdstring required

ID of the notebook to run.

detachedboolean

Run the notebook as a detached run so it does not affect the live editor session. Defaults to true; set to false to run in live mode and update outputs in the live app editor.

detachedRunStorageMode'read_write' | 'readonly'

Storage mode for the detached run. read_write (default) mounts project storage as writable; readonly mounts it as read-only so the run cannot modify the persistent project storage, but can create ephemeral files outside of the persistent project storage directory. Only applies to detached runs.

blockIdsstring[]

Optional non-empty list of unique block IDs to run. Only supported in live mode, so set detached to false when providing it. Omit to run the full notebook. When provided without runDependentBlocks, only these blocks run, in request order.

runDependentBlocksboolean

When true and blockIds is provided, also run downstream blocks that depend on the selected blocks.

inputsobject

Input values to use for this run, keyed by the input name returned from GET /notebooks/{notebookId}. Values must match the referenced input block type.

Response

Run started

runIdstring uuid required
status'pending' | 'running' | 'success' | 'error' | 'internal_error' | 'stopped' required
createdAtstring date-time required