LLM analytics API Reference

LLM analytics

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

Endpoints

`GET`
`POST`
`GET`
`PATCH`
`DELETE`
`GET`
`POST`
`GET`
`PATCH`
`DELETE`
`POST`
`GET`
`POST`
`GET`
`PATCH`
`DELETE`
`POST`

List all environments dataset items

Required API key scopes

dataset:read

Query parameters

dataset
string
limit
integer
offset
integer

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
      "input": null,
      "output": null,
      "metadata": null,
      "ref_trace_id": "string",
      "ref_timestamp": "2019-08-24T14:15:22Z",
      "ref_source_id": "string",
      "deleted": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "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": {},
        "role_at_organization": "engineering"
      },
      "team": 0
    }
  ]
}

Create environments dataset items

Required API key scopes

dataset:write

Request parameters

dataset
string
input
output
metadata
ref_trace_id
stringnull
ref_timestamp
stringnull
ref_source_id
stringnull
deleted
booleannull

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
  "input": null,
  "output": null,
  "metadata": null,
  "ref_trace_id": "string",
  "ref_timestamp": "2019-08-24T14:15:22Z",
  "ref_source_id": "string",
  "deleted": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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": {},
    "role_at_organization": "engineering"
  },
  "team": 0
}

Retrieve environments dataset items

Required API key scopes

dataset:read

Path parameters

id
string

Response

Example request

GET /api/environments/:environment_id/dataset_items/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/dataset_items/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/dataset_items/{llm_analytic_id}/".format(
        project_id=project_id,
		llm_analytic_id="<the llm analytic id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
  "input": null,
  "output": null,
  "metadata": null,
  "ref_trace_id": "string",
  "ref_timestamp": "2019-08-24T14:15:22Z",
  "ref_source_id": "string",
  "deleted": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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": {},
    "role_at_organization": "engineering"
  },
  "team": 0
}

Update environments dataset items

Required API key scopes

dataset:write

Path parameters

id
string

Request parameters

dataset
string
input
output
metadata
ref_trace_id
stringnull
ref_timestamp
stringnull
ref_source_id
stringnull
deleted
booleannull

Response

Example request

PATCH /api/environments/:environment_id/dataset_items/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/dataset_items/:id/\
	-d dataset="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/dataset_items/{llm_analytic_id}/".format(
        project_id=project_id,
		llm_analytic_id="<the llm analytic id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"dataset": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
  "input": null,
  "output": null,
  "metadata": null,
  "ref_trace_id": "string",
  "ref_timestamp": "2019-08-24T14:15:22Z",
  "ref_source_id": "string",
  "deleted": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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": {},
    "role_at_organization": "engineering"
  },
  "team": 0
}

Delete environments dataset items

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

Example request

DELETE /api/environments/:environment_id/dataset_items/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/dataset_items/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{environment_id}/dataset_items/{llm_analytic_id}/".format(
        project_id=project_id,
		llm_analytic_id="<the llm analytic id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 405 No response body

List all environments datasets

Required API key scopes

dataset:read

Query parameters

id__in
array
limit
integer
offset
integer
order_by
array
search
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "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": {},
        "role_at_organization": "engineering"
      },
      "team": 0
    }
  ]
}

Create environments datasets

Required API key scopes

dataset:write

Request parameters

name
string
description
stringnull
metadata
deleted
booleannull

Response

Example request

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

Example response

Status 201

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": {},
    "role_at_organization": "engineering"
  },
  "team": 0
}

Retrieve environments datasets

Required API key scopes

dataset:read

Path parameters

id
string

Response

Example request

GET /api/environments/:environment_id/datasets/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/datasets/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/datasets/{llm_analytic_id}/".format(
        project_id=project_id,
		llm_analytic_id="<the llm analytic 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": {},
    "role_at_organization": "engineering"
  },
  "team": 0
}

Update environments datasets

Required API key scopes

dataset:write

Path parameters

id
string

Request parameters

name
string
description
stringnull
metadata
deleted
booleannull

Response

Example request

PATCH /api/environments/:environment_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/environments/:environment_id/datasets/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/datasets/{llm_analytic_id}/".format(
        project_id=project_id,
		llm_analytic_id="<the llm analytic 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": {},
    "role_at_organization": "engineering"
  },
  "team": 0
}

Delete environments datasets

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

Example request

DELETE /api/environments/:environment_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/environments/:environment_id/datasets/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{environment_id}/datasets/{llm_analytic_id}/".format(
        project_id=project_id,
		llm_analytic_id="<the llm analytic id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 405 No response body

Create evaluation runs

Create a new evaluation run.

This endpoint validates the request and enqueues a Temporal workflow to asynchronously execute the evaluation.

Required API key scopes

evaluation:write

Request parameters

evaluation_id
string
target_event_id
string
timestamp
string
event
string
Default: $ai_generation
distinct_id
stringnull

Example request

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

Example response

Status 200

List all evaluations

Required API key scopes

evaluation:read

Query parameters

enabled
boolean
id__in
array
limit
integer
offset
integer
order_by
array
search
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "enabled": true,
      "status": "active",
      "status_reason": "trial_limit_reached",
      "evaluation_type": "llm_judge",
      "evaluation_config": {
        "prompt": "string"
      },
      "output_type": "boolean",
      "output_config": {
        "allows_na": false
      },
      "conditions": null,
      "model_configuration": {
        "provider": "openai",
        "model": "string",
        "provider_key_id": "f265db88-9bcc-4e5b-add5-bfd9a815465c",
        "provider_key_name": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "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": {},
        "role_at_organization": "engineering"
      },
      "deleted": true
    }
  ]
}

Create evaluations

Required API key scopes

evaluation:write

Request parameters

name
string
description
string
enabled
boolean
evaluation_type
evaluation_config
output_type
output_config
object
conditions
model_configuration
deleted
boolean

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "enabled": true,
  "status": "active",
  "status_reason": "trial_limit_reached",
  "evaluation_type": "llm_judge",
  "evaluation_config": {
    "prompt": "string"
  },
  "output_type": "boolean",
  "output_config": {
    "allows_na": false
  },
  "conditions": null,
  "model_configuration": {
    "provider": "openai",
    "model": "string",
    "provider_key_id": "f265db88-9bcc-4e5b-add5-bfd9a815465c",
    "provider_key_name": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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": {},
    "role_at_organization": "engineering"
  },
  "deleted": true
}

Retrieve evaluations

Required API key scopes

evaluation:read

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "enabled": true,
  "status": "active",
  "status_reason": "trial_limit_reached",
  "evaluation_type": "llm_judge",
  "evaluation_config": {
    "prompt": "string"
  },
  "output_type": "boolean",
  "output_config": {
    "allows_na": false
  },
  "conditions": null,
  "model_configuration": {
    "provider": "openai",
    "model": "string",
    "provider_key_id": "f265db88-9bcc-4e5b-add5-bfd9a815465c",
    "provider_key_name": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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": {},
    "role_at_organization": "engineering"
  },
  "deleted": true
}

Update evaluations

Required API key scopes

evaluation:write

Path parameters

id
string

Request parameters

name
string
description
string
enabled
boolean
evaluation_type
evaluation_config
output_type
output_config
object
conditions
model_configuration
deleted
boolean

Response

Example request

PATCH /api/environments/:project_id/evaluations/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/evaluations/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/evaluations/{llm_analytic_id}/".format(
        project_id=project_id,
		llm_analytic_id="<the llm analytic 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",
  "enabled": true,
  "status": "active",
  "status_reason": "trial_limit_reached",
  "evaluation_type": "llm_judge",
  "evaluation_config": {
    "prompt": "string"
  },
  "output_type": "boolean",
  "output_config": {
    "allows_na": false
  },
  "conditions": null,
  "model_configuration": {
    "provider": "openai",
    "model": "string",
    "provider_key_id": "f265db88-9bcc-4e5b-add5-bfd9a815465c",
    "provider_key_name": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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": {},
    "role_at_organization": "engineering"
  },
  "deleted": true
}

Delete evaluations

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

Required API key scopes

evaluation:write

Path parameters

id
string

Example request

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

Example response

Status 405 No response body

Create evaluations test hog

Test Hog evaluation code against sample events without saving.

Required API key scopes

evaluation:read

Request parameters

source
string
sample_count
integer
Default: 5
allows_na
boolean
Default: false
conditions
array

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "results": [
    {
      "event_uuid": "string",
      "trace_id": "string",
      "input_preview": "string",
      "output_preview": "string",
      "result": true,
      "reasoning": "string",
      "error": "string"
    }
  ],
  "message": "string"
}