How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PostHog notebooks API

The notebooks API from PostHog — 16 operation(s) for notebooks.

PostHog notebooks API is one of 139 APIs that PostHog publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Notebooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 20 operations across 16 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.posthog.com/api.

20 operations 16 paths 9 schemas 1 DELETE8 GET1 PATCH9 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.posthog.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

PostHog notebooks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PersonalAPIKeyAuth).

Paths & Operations 20

Across 16 paths, the API surfaces 20 operations — 1 DELETE, 8 GET, 1 PATCH, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

notebooks 20
GET
/api/projects/{project_id}/notebooks/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_list 8 params → 200
POST
/api/projects/{project_id}/notebooks/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_create 1 param body → 201
GET
/api/projects/{project_id}/notebooks/{short_id}/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_retrieve 2 params → 200
PUT
/api/projects/{project_id}/notebooks/{short_id}/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_update 2 params body → 200
PATCH
/api/projects/{project_id}/notebooks/{short_id}/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_partial_update 2 params body → 200
DELETE
/api/projects/{project_id}/notebooks/{short_id}/
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
notebooks_destroy 2 params → 405
GET
/api/projects/{project_id}/notebooks/{short_id}/activity/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_activity_retrieve 2 params → 200
POST
/api/projects/{project_id}/notebooks/{short_id}/collab/save/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_collab_save_create 2 params body → 200
GET
/api/projects/{project_id}/notebooks/{short_id}/collab/stream/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_collab_stream_retrieve 2 params → 200
POST
/api/projects/{project_id}/notebooks/{short_id}/hogql/execute/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_hogql_execute_create 2 params body → 200
POST
/api/projects/{project_id}/notebooks/{short_id}/kernel/config/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_kernel_config_create 2 params body → 200
GET
/api/projects/{project_id}/notebooks/{short_id}/kernel/dataframe/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_kernel_dataframe_retrieve 2 params → 200
POST
/api/projects/{project_id}/notebooks/{short_id}/kernel/execute/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_kernel_execute_create 2 params body → 200
POST
/api/projects/{project_id}/notebooks/{short_id}/kernel/execute/stream/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_kernel_execute_stream_create 2 params body → 200
POST
/api/projects/{project_id}/notebooks/{short_id}/kernel/restart/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_kernel_restart_create 2 params body → 200
POST
/api/projects/{project_id}/notebooks/{short_id}/kernel/start/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_kernel_start_create 2 params body → 200
GET
/api/projects/{project_id}/notebooks/{short_id}/kernel/status/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_kernel_status_retrieve 2 params → 200
POST
/api/projects/{project_id}/notebooks/{short_id}/kernel/stop/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_kernel_stop_create 2 params body → 200
GET
/api/projects/{project_id}/notebooks/activity/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_all_activity_retrieve 1 param → 200
GET
/api/projects/{project_id}/notebooks/recording_comments/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks_recording_comments_retrieve 1 param → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Notebook (13 properties), PatchedNotebook (13 properties), NotebookMinimal (10 properties), UserBasic (9 properties). Each schema is shown below with its type and property counts.

UserBasic
object
9 properties 4 required
PaginatedNotebookMinimalList
object
4 properties 2 required
NotebookCollabSave
object
7 properties 4 required
PatchedNotebook
object
13 properties
BlankEnum
NullEnum
RoleAtOrganizationEnum
string
engineering - Engineering data - Data product - Product Management founder - Founder leadership - Leadership marketing - Marketing sales - Sales / Success othe…
NotebookMinimal
object
10 properties 9 required
Notebook
object
13 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posthog-notebooks-api-openapi.yml Raw ↑

Other APIs PostHog publishes across the network.

PostHog Capture API
PostHog Query API
PostHog Persons API
PostHog Feature Flags API
PostHog Experiments API
PostHog Insights API
PostHog Cohorts API
PostHog Annotations API
PostHog actions API
PostHog activity_log API
PostHog activity_logs API
PostHog advanced_activity_logs API
Where this information came from

This is an independent, third-party profile of PostHog notebooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.