ai_observability

post/api/projects/{project_id}/ai_observability/offline_experiments/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/ai_observability/offline_experiments/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

idstring uuid required

Caller-generated experiment UUID. Reuse it for exact retries.

namestring required

Display name for this experiment execution.

started_atstring date-time required

Execution start time in ISO 8601 format, supplied by the caller.

expected_item_countinteger nullable

Expected number of distinct items. Completion must match this count when supplied.

expected_result_countinteger nullable

Expected number of distinct item/scorer-version results, including non-success statuses.

suite_keystring nullable

Stable identifier for comparing executions of the same evaluation suite.

dataset_sourcestring nullable

Source of an external dataset. Hosted dataset provenance is derived from its revision.

dataset_identifierstring nullable

Stable identifier for the external dataset.

dataset_revision_identifierstring nullable

Pinned revision identifier of the external dataset.

dataset_revision_idstring uuid nullable

UUID of a hosted dataset revision in this project.

application_versionstring nullable

Version of the application under evaluation.

model_versionstring nullable

Version of the model under evaluation.

prompt_versionstring nullable

Version of the prompt under evaluation.

Response

idstring uuid required

Stable experiment UUID supplied at creation.

status'uploading' | 'completed' | 'failed' required
  • uploading - Uploading
  • completed - Completed
  • failed - Failed
createdboolean required

Whether this request created the experiment.

started_atstring date-time required

Caller-supplied execution start time.

created_atstring date-time required

Time the experiment was first accepted.

finished_atstring date-time nullable required

Server closure time; null while uploading.

expected_item_countinteger nullable required

Declared item count, when supplied.

expected_result_countinteger nullable required

Declared result count, when supplied.

accepted_item_countinteger required

Number of unique accepted items.

accepted_result_countinteger required

Number of unique accepted results across all statuses.

Changes

No recorded changes to this operation across all 1 revision of this API.