---
title: "Create a project notebook"
method: POST
path: "/api/v1/project-rooms/{id}/notebooks"
tags: ["Projects"]
---

# Create a project notebook

`POST /api/v1/project-rooms/{id}/notebooks`

## Request

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

Editors create an analysis in the project’s organization. Warehouse-backed sources require the caller’s current data permission.

## Path parameters

- `id` string, required

## Request body

- object
  - `notebook` object, required
    - `attachment` union
      - object
        - `kind` 'table', required
        - `warehouseId` string, required
        - `dataset` string, required
        - `table` string, required
      - object
        - `kind` 'warehouse', required
        - `warehouseId` string, required
      - object
        - `kind` 'pipeline', required
        - `warehouseId` string, required
        - `pipelineId` string, required
        - `pipelineName` string
      - object
        - `kind` 'model', required
        - `warehouseId` string, required
        - `modelId` string, required
        - `modelName` string
      - object
        - `kind` 'none', required
        - `warehouseId` string, required
    - `cells` object[]
      - `id` string, required
      - `type` 'javascript' | 'markdown'
      - `code` string, required
      - `label` string
    - `sources` object[]
      - `warehouseId` string, required
      - `dataset` string, required
      - `table` string, required
    - `visualizations` object[]
      - `id` string, required
      - `name` string, required
      - `cellIds` string[], required
    - `name` string, required
    - `description` string

## Response `200`

Success

- object
  - `id` string, uuid, required
  - `org_id` string, uuid, required
  - `name` string, required
  - `description` string, required
  - `attachment` union, required
    - object
      - `kind` 'table', required
      - `warehouseId` string, required
      - `dataset` string, required
      - `table` string, required
    - object
      - `kind` 'warehouse', required
      - `warehouseId` string, required
    - object
      - `kind` 'pipeline', required
      - `warehouseId` string, required
      - `pipelineId` string, required
      - `pipelineName` string
    - object
      - `kind` 'model', required
      - `warehouseId` string, required
      - `modelId` string, required
      - `modelName` string
    - object
      - `kind` 'none', required
      - `warehouseId` string, required
  - `cells` object[], required
    - `id` string, required
    - `type` 'javascript' | 'markdown'
    - `code` string, required
    - `label` string
  - `sources` object[], required
    - `warehouseId` string, required
    - `dataset` string, required
    - `table` string, required
  - `visualizations` object[], required
    - `id` string, required
    - `name` string, required
    - `cellIds` string[], required
  - `revision` integer, required
  - `created_at` string, required
  - `updated_at` string, 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)