Create a Notebook

ExperimentalThis API is under active development and may change.
POST /api/0/organizations/{organization_id_or_slug}/notebooks/

Create a blank notebook, or a notebook for a producer's source. Returns 201 with notebook details, blocks, parameters, and orchestration summary, or 200 when an active notebook for the same source already exists. Requires a user or service account. Requires the organizations:investigations feature and open organization membership.

Path Parameters

organization_id_or_slug (string)
REQUIRED

The ID or slug of the organization the resource belongs to.

Body Parameters

title (string)
REQUIRED

Investigation title.

projectIds (array(integer))

Unique IDs of accessible projects to include. Defaults to an empty list.

filters (object)

Investigation filter object, stored with its original keys.

source (object)

What a producer writes this notebook about. type names a registered producer source type, and the other fields depend on it. Projects come from the source, so omit projectIds. An active notebook for the same source is returned instead of a new one.

Scopes

<auth_token> requires one of the following scopes:
  • org:admin
  • org:read
  • org:write
Copied
curl https://sentry.io/api/0/organizations/{organization_id_or_slug}/notebooks/ \
 -H 'Authorization: Bearer <auth_token>' \
 -H 'Content-Type: application/json' \
 -d '{}'
RESPONSESCHEMA
Copied
{
  "id": "7",
  "title": "Checkout latency",
  "summary": null,
  "summaryDescription": null,
  "status": "active",
  "sourceType": "manual",
  "createdBy": "1",
  "creator": {
    "type": "user",
    "id": "1"
  },
  "dateCreated": "2026-11-10T17:55:00.000000Z",
  "dateUpdated": "2026-11-10T18:00:00.000000Z",
  "version": 2,
  "blockCount": 1,
  "isFavorited": false,
  "titleGeneration": {
    "status": null
  },
  "orchestration": null,
  "template": null,
  "source": {
    "type": "manual",
    "ref": {},
    "revision": null
  },
  "filters": {},
  "projectIds": [
    1
  ],
  "parameters": [],
  "blocks": [
    {
      "id": "12",
      "position": 0,
      "kind": "text",
      "title": "Summary",
      "content": "Checkout latency rose after the 2.4.0 release.",
      "generationPrompt": "",
      "generatedContent": "Checkout latency rose after the 2.4.0 release.",
      "output": {
        "schemaVersion": 1,
        "markdown": "Checkout latency rose after the 2.4.0 release."
      },
      "outputStatus": "available",
      "currentExecution": {
        "id": "40",
        "status": "completed",
        "executor": "code_mode",
        "schemaVersion": 1,
        "startedAt": "2026-11-10T18:00:00.000000Z",
        "completedAt": "2026-11-10T18:00:00.000000Z",
        "error": null
      },
      "config": {},
      "display": {
        "type": "markdown"
      },
      "dependencies": [],
      "parameterKeys": [],
      "version": 1,
      "staleAt": null,
      "createdBy": null,
      "lastEditedBy": null,
      "producerKey": "summary",
      "producerRevision": 1
    }
  ],
  "actionRequests": []
}
Was this helpful?