API referenceIngest & observe

Ingest & observe — API reference

Send traces and read back sessions, conversations, agents, and the agent topology.

Generated from the live OpenAPI schema (version 0.16.6). Download the full spec at /docs/openapi.json.

ingest

POST /ingest/batch

Ingest Batch

High-volume batch ingest: many raw sessions in one request.

Details

Parameters

ParameterInTypeRequiredDescription
syncquerybooleanno

Responses

StatusDescription
200Successful Response
422Validation Error

POST /ingest/openinference

Ingest Openinference

Details

Parameters

ParameterInTypeRequiredDescription
syncquerybooleanno

Responses

StatusDescription
200Successful Response
422Validation Error

POST /ingest/otlp

Ingest Otlp

Details

Parameters

ParameterInTypeRequiredDescription
syncquerybooleanno

Responses

StatusDescription
200Successful Response
422Validation Error

POST /ingest/raw

Ingest Raw

Details

Parameters

ParameterInTypeRequiredDescription
syncquerybooleanno

Responses

StatusDescription
200Successful Response
422Validation Error

POST /v1/traces

Otlp Traces

OTLP/HTTP trace receiver. Accepts protobuf or JSON; enqueues and returns an OTLP response.

Details

Parameters

ParameterInTypeRequiredDescription
syncquerybooleanno

Responses

StatusDescription
200Successful Response
422Validation Error

traces

GET /agent-graph

Cohort Agent Graph

Cross-cohort aggregate agent/tool topology.

Details

Parameters

ParameterInTypeRequiredDescription
statusquerystring[]no
agent_namequerystring | nullno
sourcequerystring | nullno
min_turnsqueryinteger | nullno
max_turnsqueryinteger | nullno
min_duration_msqueryinteger | nullno
max_duration_msqueryinteger | nullno
min_spansqueryinteger | nullno
max_spansqueryinteger | nullno
min_tokensqueryinteger | nullno
max_tokensqueryinteger | nullno
min_input_tokensqueryinteger | nullno
max_input_tokensqueryinteger | nullno
min_output_tokensqueryinteger | nullno
max_output_tokensqueryinteger | nullno
modelquerystring[]no
tool_namequerystring[]no
span_kindquerystring[]no
span_statusquerystring[]no
tagsquerystring[]no
cluster_idquerystring | nullno
failure_setquerybooleanno
bucketquerystring | nullno
conversation_idquerystring | nullno
session_idquerystring | nullno
score_metricquerystring | nullno
score_statusquerystring | nullno
score_labelquerystring | nullno
issue_modequerystring | nullno
versionquerystring | nullno
hourquerystring | nullno
started_afterquerystring | nullno
started_beforequerystring | nullno
enrichmentquerystring[]no
qquerystring | nullno

Responses

StatusDescription
200Successful Response
422Validation Error

GET /sessions

List Sessions

Details

Parameters

ParameterInTypeRequiredDescription
statusquerystring[]no
agent_namequerystring | nullno
sourcequerystring | nullno
pagequeryintegerno
page_sizequeryintegerno
min_turnsqueryinteger | nullno
max_turnsqueryinteger | nullno
min_duration_msqueryinteger | nullno
max_duration_msqueryinteger | nullno
min_spansqueryinteger | nullno
max_spansqueryinteger | nullno
min_tokensqueryinteger | nullno
max_tokensqueryinteger | nullno
min_input_tokensqueryinteger | nullno
max_input_tokensqueryinteger | nullno
min_output_tokensqueryinteger | nullno
max_output_tokensqueryinteger | nullno
modelquerystring[]no
tool_namequerystring[]no
span_kindquerystring[]no
span_statusquerystring[]no
tagsquerystring[]no
cluster_idquerystring | nullno
failure_setquerybooleanno
bucketquerystring | nullno
conversation_idquerystring | nullno
session_idquerystring | nullno
score_metricquerystring | nullno
score_statusquerystring | nullno
score_labelquerystring | nullno
issue_modequerystring | nullno
versionquerystring | nullno
hourquerystring | nullno
started_afterquerystring | nullno
started_beforequerystring | nullno
enrichmentquerystring[]no
qquerystring | nullno

Responses

StatusDescription
200Successful Response
422Validation Error

GET /sessions/filter-options

Filter Options

Details

Responses

StatusDescription
200Successful Response

GET /sessions/trend

Sessions Trend

Volume trend for the Traces page: per-day (or per-hour) trace counts, token usage (input and output), p50 latency and estimated spend over the selected time window, plus a period-over-period summary. Counts individual traces.

Details

Parameters

ParameterInTypeRequiredDescription
rangequerystring | nullno
fromquerystring | nullno
toquerystring | nullno
started_afterquerystring | nullno
started_beforequerystring | nullno
grainquerystring | nullno
statusquerystring | nullno
modelquerystring | nullno
agent_namequerystring | nullno
sourcequerystring | nullno
versionquerystring | nullno
qquerystring | nullno
group_byquerystring | nullno

Responses

StatusDescription
200Successful Response
422Validation Error

GET /sessions/{session_id}

Get Session

Details

Parameters

ParameterInTypeRequiredDescription
session_idpathstringyes

Responses

StatusDescription
200Successful Response
422Validation Error

GET /sessions/{session_id}/agent-graph

Agent Graph

Aggregate agent/tool topology for one run.

Details

Parameters

ParameterInTypeRequiredDescription
session_idpathstringyes

Responses

StatusDescription
200Successful Response
422Validation Error

POST /sessions/{session_id}/feedback

Submit Feedback

Record end-user feedback on a conversation — a CSAT rating or a thumbs up/down — without a helpdesk integration.

Details

Parameters

ParameterInTypeRequiredDescription
session_idpathstringyes

Request body (application/json) — required

FieldTypeRequiredDescription
ratingnumber | nullno
thumbstring | nullno
commentstring | nullno

Responses

StatusDescription
201Successful Response
422Validation Error

GET /sessions/{session_id}/similar

Similar Sessions

Sessions most similar to session_id (“more like this”), up to limit. Returns [] when similarity search is unavailable.

Details

Parameters

ParameterInTypeRequiredDescription
session_idpathstringyes
limitqueryintegerno

Responses

StatusDescription
200Successful Response
422Validation Error

conversations

GET /conversations

List Conversations

Details

Parameters

ParameterInTypeRequiredDescription
statusquerystring[]no
agent_namequerystring | nullno
sourcequerystring | nullno
conversation_idquerystring | nullno
session_idquerystring | nullno
pagequeryintegerno
page_sizequeryintegerno
min_turnsqueryinteger | nullno
max_turnsqueryinteger | nullno
min_duration_msqueryinteger | nullno
max_duration_msqueryinteger | nullno
min_spansqueryinteger | nullno
max_spansqueryinteger | nullno
min_tokensqueryinteger | nullno
max_tokensqueryinteger | nullno
min_input_tokensqueryinteger | nullno
max_input_tokensqueryinteger | nullno
min_output_tokensqueryinteger | nullno
max_output_tokensqueryinteger | nullno
modelquerystring[]no
tool_namequerystring[]no
span_kindquerystring[]no
span_statusquerystring[]no
tagsquerystring[]no
cluster_idquerystring | nullno
score_metricquerystring | nullno
score_statusquerystring | nullno
score_labelquerystring | nullno
issue_modequerystring | nullno
versionquerystring | nullno
hourquerystring | nullno
started_afterquerystring | nullno
started_beforequerystring | nullno
qquerystring | nullno

Responses

StatusDescription
200Successful Response
422Validation Error

GET /conversations/trend

Conversations Trend

Volume trend for the Sessions page: per-day (or per-hour) session counts, token usage (input and output), p50 latency and estimated spend over the selected time window, plus a period-over-period summary. Counts distinct sessions.

Details

Parameters

ParameterInTypeRequiredDescription
rangequerystring | nullno
fromquerystring | nullno
toquerystring | nullno
started_afterquerystring | nullno
started_beforequerystring | nullno
grainquerystring | nullno
statusquerystring | nullno
modelquerystring | nullno
agent_namequerystring | nullno
sourcequerystring | nullno
versionquerystring | nullno
qquerystring | nullno
group_byquerystring | nullno

Responses

StatusDescription
200Successful Response
422Validation Error

GET /conversations/{conversation_id}

Get Conversation

Details

Parameters

ParameterInTypeRequiredDescription
conversation_idpathstringyes

Responses

StatusDescription
200Successful Response
422Validation Error

GET /conversations/{conversation_id}/agent-graph

Conversation Agent Graph

Aggregate agent/tool topology for a whole conversation.

Details

Parameters

ParameterInTypeRequiredDescription
conversation_idpathstringyes

Responses

StatusDescription
200Successful Response
422Validation Error

POST /conversations/{conversation_id}/annotations

Add Conversation Annotation

Create one annotation (targetType ‘session’, targetId = member trace id) per member trace of the conversation, mirroring api/annotations.py’s contract + reviewer attribution. Returns the created count.

Details

Parameters

ParameterInTypeRequiredDescription
conversation_idpathstringyes

Request body (application/json) — required

FieldTypeRequiredDescription
valuestringyes
commentstring | nullno

Responses

StatusDescription
200Successful Response
422Validation Error

POST /conversations/{conversation_id}/labels

Add Conversation Label

Apply a tag to EVERY member trace of the conversation (idempotent, mirroring the single-trace POST /sessions/{id}/labels path). The written session_labels rows make the tag show up in the Sessions/Traces “Tags” filter. Returns the applied count.

Details

Parameters

ParameterInTypeRequiredDescription
conversation_idpathstringyes

Request body (application/json) — required

FieldTypeRequiredDescription
labelstringyes

Responses

StatusDescription
200Successful Response
422Validation Error

agents

GET /agents

List Agents

Details

Responses

StatusDescription
200Successful Response

labels

GET /labels

List Labels

Details

Responses

StatusDescription
200Successful Response

POST /sessions/{session_id}/labels

Add Label

Details

Parameters

ParameterInTypeRequiredDescription
session_idpathstringyes

Request body (application/json) — required

FieldTypeRequiredDescription
labelstringyes

Responses

StatusDescription
200Successful Response
422Validation Error

DELETE /sessions/{session_id}/labels/{label}

Remove Label

Details

Parameters

ParameterInTypeRequiredDescription
session_idpathstringyes
labelpathstringyes

Responses

StatusDescription
200Successful Response
422Validation Error

activity

GET /activity/runs

List Runs

Details

Parameters

ParameterInTypeRequiredDescription
kindquerystring | nullno
statequerystring | nullno
statusquerystring | nullno
started_afterquerystring | nullno
started_beforequerystring | nullno
sort_byquerystring | nullno
sort_dirquerystring | nullno
limitqueryintegerno

Responses

StatusDescription
200Successful Response
422Validation Error

GET /activity/trend

Activity Trend

Event-volume trend for the Activity page: per-day (or per-hour) count of activity runs over the selected window, plus a period-over-period total. Scoped to the current project like the feed. Queued-but-unstarted runs are excluded — they have no place on a time axis yet.

Details

Parameters

ParameterInTypeRequiredDescription
rangequerystring | nullno
fromquerystring | nullno
toquerystring | nullno
grainquerystring | nullno

Responses

StatusDescription
200Successful Response
422Validation Error

GET /eval-runs/{run_id}/metrics

Run Metrics

Real pipeline metrics for a score run, derived from activity_runs + eval_tasks (no synthetic data). run_id is the activity-run id (act_eval_{eval_run_id}).

Details

Parameters

ParameterInTypeRequiredDescription
run_idpathstringyes

Responses

StatusDescription
200Successful Response
422Validation Error

stats

GET /stats

Get Stats

Details

Parameters

ParameterInTypeRequiredDescription
rangequerystringno
fromquerystring | nullno
toquerystring | nullno

Responses

StatusDescription
200Successful Response
422Validation Error

GET /stats/timeseries

Get Timeseries

Details

Parameters

ParameterInTypeRequiredDescription
rangequerystringno
fromquerystring | nullno
toquerystring | nullno

Responses

StatusDescription
200Successful Response
422Validation Error

overview

GET /overview/kpis

Overview Kpis

Hero KPI row: spine counts + scope-wide trace/session/error/spend totals + deltas.

Details

Parameters

ParameterInTypeRequiredDescription
rangequerystringno
fromquerystring | nullno
toquerystring | nullno

Responses

StatusDescription
200Successful Response
422Validation Error

GET /overview/segments

Overview Segments

Segmentation table: scope sliced by org | project | agent.

Details

Parameters

ParameterInTypeRequiredDescription
byquerystringno
rangequerystringno
fromquerystring | nullno
toquerystring | nullno

Responses

StatusDescription
200Successful Response
422Validation Error

GET /overview/timeseries

Overview Timeseries

Tenant trends: per-day traces / sessions / errors / eval pass-rate / spend over the range.

Details

Parameters

ParameterInTypeRequiredDescription
rangequerystringno
fromquerystring | nullno
toquerystring | nullno

Responses

StatusDescription
200Successful Response
422Validation Error