Notebooks-2 API Reference

Notebooks-2

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

`GET`
`POST`
`GET`
`GET`

Retrieve notebooks kernel status

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

Path parameters

short_id
string

Example request

GET /api/projects/:project_id/notebooks/:short_id/kernel/status
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/notebooks/:short_id/kernel/status/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/notebooks/{short_id}/kernel/status/".format(
        project_id=project_id,
		short_id="<the short id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create notebooks kernel stop

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

Path parameters

short_id
string

Request parameters

title
stringnull
content
text_content
stringnull
version
integer
deleted
boolean
_create_in_folder
string

Example request

POST /api/projects/:project_id/notebooks/:short_id/kernel/stop
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/notebooks/:short_id/kernel/stop/\
	-d title=["string","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/notebooks/{short_id}/kernel/stop/".format(
        project_id=project_id,
		short_id="<the short id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"title": [
			"string",
			"null"
		]
	}
).json()

Example response

Status 200 No response body

Retrieve notebooks all activity

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

Example request

GET /api/projects/:project_id/notebooks/activity
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/notebooks/activity/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/notebooks/activity/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve notebooks recording comments

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

Example request

GET /api/projects/:project_id/notebooks/recording_comments
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/notebooks/recording_comments/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/notebooks/recording_comments/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

← Previous page

Notebooks-2

Endpoints

Retrieve notebooks kernel status

Path parameters

Example request

Example response

Status 200 No response body

Create notebooks kernel stop

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve notebooks all activity

Example request

Example response

Status 200 No response body

Retrieve notebooks recording comments

Example request

Example response

Status 200 No response body

Community questions