Llm API Reference

Llm

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

Endpoints

`GET`
`PATCH`
`DELETE`

Retrieve datasets retrieve

Required API key scopes

dataset:read

Path parameters

id
string
project_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "metadata": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted": true,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "team": 0
}

Update datasets update

Required API key scopes

dataset:write

Path parameters

id
string
project_id
string

Request parameters

name
string
description
string
metadata
deleted
boolean

Response

Example request

PATCH /api/projects/:project_id/datasets/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/datasets/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/datasets/{llm_analytics-2_id}/".format(
        project_id=project_id,
		llm_analytics-2_id="<the llm analytics-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "metadata": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted": true,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "team": 0
}

Delete datasets destroy

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

dataset:write

Path parameters

id
string
project_id
string

Example request

DELETE /api/projects/:project_id/datasets/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/datasets/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/datasets/{llm_analytics-2_id}/".format(
        project_id=project_id,
		llm_analytics-2_id="<the llm analytics-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Llm

Endpoints

Retrieve datasets retrieve

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update datasets update

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete datasets destroy

Required API key scopes

Path parameters

Example request

Example response

Status 405 No response body

Community questions