Deepnote Public API v2
Runs API
Notebook executions.
Base URL
https://api.deepnote.com/v2Run a notebook
/runsRequest body
objectnotebookIdrequiredstringID of the notebook to run.
detachedbooleanRun the notebook as a detached run so it does not affect the live editor session.
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. Omit to run the full notebook. When provided without `runDependentBlocks`, only these blocks run, in request order.
runDependentBlocksbooleanWhen true and `blockIds` is provided, also run downstream blocks that depend on the selected blocks.
inputsobjectInput values to use for this run, keyed by the input `name` returned from `GET /notebooks/{notebookId}`. Values must match the referenced input block type.
Responses
▸202Run started
CreateRunResponserunIdrequiredstring:uuidstatusrequired"pending" | "running" | "success" | "error" | "internal_error" | "stopped"createdAtrequiredstring:date-time▸400Validation error or notebook/project issue
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
ErrorResponsemessagerequiredstring▸500Hardware unable to start
ErrorResponsemessagerequiredstringGet a run
/runs/{runId}Parameters
runIdpathrequiredstring:uuidsnapshotDeliveryquery"inline" | "downloadUrl"Controls how an available run snapshot is returned. Defaults to `downloadUrl`. Use `inline` to return `snapshotContent` directly.
Responses
▸200Run details
GetRunResponserunrequiredRun▸400Validation error
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Run not found
ErrorResponsemessagerequiredstring▸409Project is suspended
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
ErrorResponsemessagerequiredstring▸500Internal server error
ErrorResponsemessagerequiredstring