Read an experiment's results
GET /v1/agents/{agent_id}/experiments/{experiment_id}/results
| Property | Value |
|---|---|
| Operation | get_experiment_results |
| Group | Prompt evaluations and experiments |
| Scope | agents:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | Not audited: A configuration read; an experiment and its results hold no Call content. |
| Released in | 1.55.0 |
| Phase 0 host | Served (the hosted api pins 1.65.0) |
Answers per arm the Calls, Turns, ended reasons, transfer and Tool error rates with 95 percent intervals and sample sizes, Policy firings per 100 Turns, duration and voice-to-voice latency, computed over the Calls finalized so far (1.55.0), and from 1.63.0 the share that met the experiment's goal and the judged metrics of the sampled Calls under live_call_judging. Vocal never declares a winner.
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the agents:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.
curl "$VOCAL_API/v1/agents/agt_.../experiments/exp_.../results" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/agents/agt_.../experiments/exp_.../results`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/agents/agt_.../experiments/exp_.../results",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
agent_id | path | AgentId | yes | The id of an Agent: agt_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. |
experiment_id | path | ExperimentId | yes | The id of a traffic-split experiment: exp_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. |
Responses
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | ExperimentResults | |
400 | application/json | ErrorEnvelope | invalid_request |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
404 | application/json | ErrorEnvelope | not_found |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is ExperimentResults.
| Field | Type | Required | Description |
|---|---|---|---|
agent_id | AgentId | yes | |
arms | array of ExperimentArmResult | yes | |
computed_at | Timestamp | yes | |
experiment_id | ExperimentId | yes | |
object | "experiment_results" | yes | |
status | ExperimentStatus | yes |