Session API Reference

Session

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

Endpoints

`POST`
`POST`

Create create session

Generate AI summary for a group of session recordings to find patterns and generate a notebook.

Path parameters

project_id
string

Request parameters

session_ids
array
focus_area
string

Response

Example request

POST /api/environments/:project_id/session_summaries/create_session_summaries
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/environments/:project_id/session_summaries/create_session_summaries/\
	-d session_ids="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/session_summaries/create_session_summaries/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"session_ids": "array"
	}
).json()

Example response

Status 200

RESPONSE
{
  "session_ids": [
    "string"
  ],
  "focus_area": "string"
}

Create create session summaries

Generate AI individual summary for each session, without grouping.

Path parameters

project_id
string

Request parameters

session_ids
array
focus_area
string

Response

Example request

POST /api/environments/:project_id/session_summaries/create_session_summaries_individually
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/environments/:project_id/session_summaries/create_session_summaries_individually/\
	-d session_ids="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/session_summaries/create_session_summaries_individually/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"session_ids": "array"
	}
).json()

Example response

Status 200

RESPONSE
{
  "session_ids": [
    "string"
  ],
  "focus_area": "string"
}

Session

Endpoints

Create create session

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Create create session summaries

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Community questions