Sign in
latestOpenAPI 3.1.02026-08-204489152.5 KB

726970fd2992

Sessions

Submit a run on an interactive session

Runs a notebook, or specific blocks of it, in an existing interactive session. Only the session creator may submit runs. Submissions while the notebook is busy are accepted and queue on the session kernel; retrying a submit creates a new queued run.

post/sessions/{sessionId}/runs

Path parameters

sessionIdstring uuid required

Session identifier.

Session identifier.

Request body

notebookIdstring required

ID of the notebook to run within the session. Use the session's source notebook ID (session.notebookId), not sessionNotebookId.

blockIdsstring[]

Optional non-empty list of unique block IDs to run, in request order. Omit to run the whole notebook. Use session block IDs from the session's notebook copy (see sessionNotebookId on the session); source-notebook block IDs are rejected.

inputsobject

Input values to use for this run, keyed by the input name returned from GET /notebooks/{sessionNotebookId} (the session's editable copy, which the run resolves inputs against). Values must match the referenced input block type.

Response

Run accepted

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