Evaluation runs API Reference

Evaluation runs

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

Endpoints

POST

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

Path parameters

project_id
string

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/
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)},
).json()

Evaluation runs

Endpoints

Create evaluation runs

Required API key scopes

Path parameters

Example request

Example response

Status 201 No response body

Community questions