VocalDocscontracts 1.65.0

Read a conversation test run

GET /v1/agents/{agent_id}/versions/{version}/tests/{run_id}

PropertyValue
Operationget_agent_version_test_run
GroupAgent versions
Scopeprompts:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A metadata read; a report holds ids, codes and counts only.
Released in1.55.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Answers the report of a conversation test run (1.55.0): per test and repetition, each expectation met or not with the count that decided it, the Call by id, its ended reason and Turn count. Ids, codes and counts only, so the read is not audited. From 1.64.0, stated: each Call the report names, of inline tests or of a suite, is a test Call read through get_call and its Turns and text through get_call_transcript, an audited content read, as for any test Call; get_prompt_eval_call reads the Calls of the runs of a suite, and an inline test, having no suite, has no other route.

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/agents/agt_.../versions/1/tests/per_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
agent_idpathAgentIdyesThe id of an Agent: agt_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
versionpathintegeryesA version number, from 1.
run_idpathPromptEvalRunIdyesThe 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.

Responses

StatusContent typeShapeError codes
200application/jsonConversationTestRun
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is ConversationTestRun.

FieldTypeRequiredDescription
agent_idAgentIdyes
agent_versionintegeryes
cost_linesarray of PromptEvalCostLineyes
created_atTimestampyes
created_byActorRefyes
error_codestring or nullyes
finished_atTimestamp or nullyes
gatePromptEvalGateOutcome or nullnoHow the run fares against its suite's publish gate (1.63.0), once completed; null for inline tests, for a suite with no gate and before completion. Absent from an api before 1.63.0.
idPromptEvalRunIdyes
job_idJobIdyesThe agent.conversation_test job that runs it.
object"conversation_test_run"yes
repetitionsintegeryes
started_atTimestamp or nullyes
statusPromptEvalRunStatusyes
suite_idPromptEvalSuiteId or nullyesNull for inline tests.
summaryConversationTestSummary or nullyesNull until completed.
testsarray of ConversationTestReportyesOne report per test, in the order of the suite or the request; empty until run.