VocalDocscontracts 1.65.0

List evaluation suites

GET /v1/prompt-eval-suites

PropertyValue
Operationlist_prompt_eval_suites
GroupPrompt evaluations and experiments
Scopeprompts:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; a suite holds no Call content, and a scenario read that names include=text is audited instead.
Released in1.55.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Lists the evaluation suites of the Organization, newest first (1.55.0), optionally of one Agent; archived ones only with archived=true.

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

Parameters

NameInTypeRequiredDescription
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
agent_idqueryAgentIdnoOnly the suites of this Agent.
archivedqueryone of "true", "false"notrue lists only archived suites; false, the default, only the others.

Responses

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

Fields of the 200 answer

The shape is PromptEvalSuiteList.

FieldTypeRequiredDescription
dataarray of PromptEvalSuiteyesThe suites 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