VocalDocscontracts 1.65.0

List a suite's runs

GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/runs

PropertyValue
Operationlist_prompt_eval_runs
GroupPrompt evaluations and experiments
Scopeprompts:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A metadata read; a run holds ids, counts and rates only.
Released in1.56.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Lists the runs of a suite, newest first, optionally by status (1.56.0): each run as get_prompt_eval_run answers it, ids, counts and rates only.

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" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
prompt_eval_suite_idpathPromptEvalSuiteIdyesThe id of an evaluation suite: pes_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
statusqueryPromptEvalRunStatusnoOnly the runs in this status.

Responses

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

Fields of the 200 answer

The shape is PromptEvalRunList.

FieldTypeRequiredDescription
dataarray of PromptEvalRunyesThe evaluation runs of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes