AI observability
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
POST | |
POST | |
POST | |
POST |
Retrieve ai observability traces summary
The trace's AI summary: pending while it is written, then ready with links to its steps, or failed with the reason. A summary is kept for an hour and shown only to users whose property access matches the requester's.
Required API key scopes
llm_analytics:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /ai_observability /traces /:id /summaryExample response
Status 200
Status 400 The encoded trace id is malformed.
Status 403 The organization has not approved AI data processing.
Status 404 No summary of this trace that this user may see.
Create ai observability traces summary
Request an AI summary of the trace. A ready summary is returned as is unless regenerate is set; otherwise a job starts writing one, or the request joins the job already writing it.
Required API key scopes
llm_analytics:writePath parameters
- idstring
Query parameters
- timestamp_hintstring
Request parameters
- regeneratebooleanDefault:
false
Response
Example request
POST /api /projects /:project_id /ai_observability /traces /:id /summaryExample response
Status 200 A ready or failed summary.
Status 202 The summary is being written.
Status 400 The timestamp hint or the encoded trace id is malformed.
Status 403 The organization has not approved AI data processing.
Status 429 Too many summaries requested.
Retrieve ai observability traces
A trace ready to render: its tree with roll-ups, timeline, totals and person, without inputs or outputs.
Required API key scopes
llm_analytics:readPath parameters
- idstring
Query parameters
- timestamp_hintstring
Response
Example request
GET /api /projects /:project_id /ai_observability /traces /:idExample response
Status 200
Status 400 The timestamp hint or the encoded trace id is malformed.
Status 404 No trace with this id in the project.
Status 429 Too many queries are running for the project or organization.
Create ai observability traces availability
Required API key scopes
llm_analytics:readRequest parameters
- trace_idsarray
Response
Example request
POST /api /projects /:project_id /ai_observability /traces /availabilityExample response
Status 200
Status 429 Too many queries are running for the project or organization.
Create ai observability traces people
The person each trace on a page ran for, labeled by the project's display name properties.
Required API key scopes
llm_analytics:readRequest parameters
- trace_idsarray
- earliest_created_atstring
- latest_created_atstring
Response
Example request
POST /api /projects /:project_id /ai_observability /traces /peopleExample response
Status 200
Status 400 The trace IDs or the page bounds are invalid.
Status 429 Too many queries are running for the project or organization.
Create ai observability traces previews
The input and output previews of a page of traces: the user's message each trace answered and its answer.
Required API key scopes
llm_analytics:readRequest parameters
- trace_idsarray
Response
Example request
POST /api /projects /:project_id /ai_observability /traces /previewsExample response
Status 200
Status 400 The trace IDs are missing or too many.
Status 429 Too many queries are running for the project or organization.
Create ai observability traces sentiment
The sentiment of each trace on a page, from its sentiment evaluation results.
Required API key scopes
llm_analytics:readRequest parameters
- trace_idsarray
- earliest_created_atstring
- latest_created_atstring
Response
Example request
POST /api /projects /:project_id /ai_observability /traces /sentiment




