---
title: "Read a notebook run"
method: GET
path: "/api/v1/project-rooms/{id}/notebooks/{notebookId}/runs/{runId}"
tags: ["Projects"]
---

# Read a notebook run

`GET /api/v1/project-rooms/{id}/notebooks/{notebookId}/runs/{runId}`

## Request

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

Returns run status and bounded artifact metadata. Access to results is checked against current warehouse permissions.

## Path parameters

- `id` string, required
- `notebookId` string, uuid, required
- `runId` string, uuid, required

## Response `200`

Success

- object
  - `id` string, uuid, required
  - `revision` integer, required
  - `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'timed_out', required
  - `created_at` string, date-time, required
  - `deadline` string, date-time, required
  - `finished_at` string, date-time, nullable, required
  - `result` object, nullable, required
    - `error` string
    - `runtime_sha256` string
    - `artifacts` object[]
      - `name` string, required
      - `cell_id` string
      - `content_type` 'application/json' | 'image/png', required
      - `bytes` integer, required

## Other responses

- `400`: The request did not match the contract.
- `401`: Missing or invalid credentials.
- `429`: Rate limit exceeded. Wait `Retry-After` seconds; `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` report the budget. Signed-in sessions and API keys have larger budgets than anonymous callers.

---

[API](https://skmtc.dev/askthegrid/apis/ask-the-grid-api.md) · [All operations](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/llms.txt) · [OpenAPI document](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/revisions/9cd80115e395?raw)