Projects

Run a project notebook

Queues analysis using expected_revision and a UUID request_key. Reuse the request_key when retrying the same request; poll getProjectNotebookRun for completion.

post/api/v1/project-rooms/{id}/notebooks/{notebookId}/runs

Request

  • Base URL: https://askthegrid.com
  • URL: https://askthegrid.com/api/v1/project-rooms/{id}/notebooks/{notebookId}/runs
  • Auth: HTTP bearer

Path parameters

idstring required
notebookIdstring uuid required

Request body

Response

Success

idstring uuid required
revisioninteger required
status'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'timed_out' required
created_atstring date-time required
deadlinestring date-time required
finished_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.