Read an evaluation Call of a run
GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/runs/{run_id}/calls/{call_id}
| Property | Value |
|---|---|
| Operation | get_prompt_eval_call |
| Group | Prompt evaluations and experiments |
| Scope | prompts:read |
Scopes of include values | transcript needs transcripts:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | An audited content read evaluations.prompt_eval_call.read, when the request names an include value |
| Released in | 1.63.0 |
| Phase 0 host | Served (the hosted api pins 1.65.0) |
Answers one evaluation Call of the run (1.63.0): its scenario, arm, repetition and model family, how it ended, and its Turn metrics without text. transcript is null unless include=transcript adds the text of its Turns, which needs transcripts:read and makes the read an audited content read, as get_call_transcript is; this is what a calibration's labeller reads. An evaluation Call is a test Call, so a live API key is answered not_found, as for any test Call; a Call of another run is not_found; and a Call a worker before 1.63.0 reported answers no Turn and a null transcript.
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the prompts:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.
curl "$VOCAL_API/v1/prompt-eval-suites/pes_.../runs/per_.../calls/call_..." \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/prompt-eval-suites/pes_.../runs/per_.../calls/call_...`, {
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/prompt-eval-suites/pes_.../runs/per_.../calls/call_...",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
prompt_eval_suite_id | path | PromptEvalSuiteId | yes | The id of an evaluation suite: pes_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. |
run_id | path | PromptEvalRunId | yes | The id of an evaluation run or a conversation test run: per_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. |
call_id | path | CallId | yes | The id of a Call: call_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. |
include | query | array of PromptEvalCallInclude | no | Content classes to add, comma-separated: transcript answers the text of the Turns, needs transcripts:read and makes the read an audited content read (1.63.0). |
Responses
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | PromptEvalCall | |
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 PromptEvalCall.
| Field | Type | Required | Description |
|---|---|---|---|
arm | PromptEvalArm | yes | |
call_id | CallId | yes | |
ended_at | Timestamp or null | yes | |
ended_reason | EndedReason or null | yes | |
key | PromptEvalKey or null | yes | The key of an inline test; else null. |
model_family | ModelFamily or null | yes | The family the Call ran under; null for the family of the chain's primary. |
object | "prompt_eval_call" | yes | |
repetition | integer | yes | |
run_id | PromptEvalRunId | yes | |
scenario_id | PromptEvalScenarioId or null | yes | Null for an inline test. |
started_at | Timestamp or null | yes | |
suite_id | PromptEvalSuiteId | yes | |
transcript | array or null | yes | The text of each Turn, the content class transcript: null unless the read names include=transcript, and null once scrubbed or for an older worker. |
turns | array of TurnMetrics | yes | The Turn metrics, without text, Turn 0 first; empty for an older worker. |