notebooks

The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.

post/api/projects/{project_id}/notebooks/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/notebooks/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

idstring uuid required

UUID of the notebook.

short_idstring required

Short alphanumeric identifier used in URLs and API lookups.

titlestring nullable

Title of the notebook.

contentunknown
text_contentstring nullable

Plain text representation of the notebook content for search.

versioninteger

Version number for optimistic concurrency control. Must match the current version when updating content.

deletedboolean

Whether the notebook has been soft-deleted.

created_atstring date-time required
last_modified_atstring date-time required
user_access_levelstring nullable required

The effective access level the user has for this object

_create_in_folderstring

Response

idstring uuid required

UUID of the notebook.

short_idstring required

Short alphanumeric identifier used in URLs and API lookups.

titlestring nullable

Title of the notebook.

contentunknown
text_contentstring nullable

Plain text representation of the notebook content for search.

versioninteger

Version number for optimistic concurrency control. Must match the current version when updating content.

deletedboolean

Whether the notebook has been soft-deleted.

created_atstring date-time required
last_modified_atstring date-time required
user_access_levelstring nullable required

The effective access level the user has for this object

_create_in_folderstring

Changes

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