VocalDocscontracts 1.65.0

List the cases of a decision corpus

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

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

Pages the cases with their states (1.58.0), an audited content read; from 1.59.0 source filters the page. A page that holds a production case whose state the reader may not read is refused whole, so such a reader lists synthetic cases with the filter. From 1.59.0 the state of a production case is of the content class transcripts of its Call: an API key needs transcripts:read beside agents:read, and a Member reads it when get_call_content_access answers allowed for that class of the Call; otherwise the read is 403 forbidden with the detail permission_required, class_denied or reveal_grant_required, as the trace route words them.

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-corpora/dcp_.../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.
corpus_idpathDecisionCorpusIdyesThe id of a decision corpus: dcp_ 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 (1.59.0), such as synthetic for a reader who may not read the transcripts of the Calls of production cases.

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