VocalDocscontracts 1.65.0

List the cases of every decision corpus of an Agent

GET /v1/agents/{agent_id}/decision-cases

PropertyValue
Operationlist_agent_decision_cases
GroupDecision corpora
Scopeagents:read
Route classread
IdempotencyNo Idempotency-Key
AuditAn audited content read decision_case.list
Released in1.60.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Pages the cases of all the Agent's corpora, archived ones included, newest first, each naming its corpus_id (1.60.0), with optional filters by source and question_set; an audited content read under the rules of list_decision_cases: a page that holds a production case whose state the reader may not read is refused whole with 403 forbidden, so such a reader lists synthetic cases with the filter.

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_.../decision-cases" \
  -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.
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
sourcequeryDecisionCaseSourcenoOnly the cases of this source.
question_setqueryQuestionSetKeynoOnly the cases of the corpora of this question set.

Responses

StatusContent typeShapeError codes
200application/jsonDecisionCaseList
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 DecisionCaseList.

FieldTypeRequiredDescription
dataarray of DecisionCaseyesThe decision cases 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