List the cases of a decision corpus
GET /v1/agents/{agent_id}/decision-corpora/{corpus_id}/cases
| Property | Value |
|---|---|
| Operation | list_decision_cases |
| Group | Decision corpora |
| Scope | agents:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | An audited content read decision_case.list |
| Released in | 1.58.0 |
| Phase 0 host | Served (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"const response = await fetch(`${process.env.VOCAL_API}/v1/agents/agt_.../decision-corpora/dcp_.../cases`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/agents/agt_.../decision-corpora/dcp_.../cases",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
agent_id | path | AgentId | yes | The id of an Agent: agt_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. |
corpus_id | path | DecisionCorpusId | yes | The id of a decision corpus: dcp_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. |
limit | query | integer | no | The page size, 1 to 100. |
cursor | query | string | no | The opaque next_cursor of the previous page; it binds the filters it was issued under. |
source | query | DecisionCaseSource | no | Only 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
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | DecisionCaseList | |
400 | application/json | ErrorEnvelope | invalid_request, invalid_cursor |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
404 | application/json | ErrorEnvelope | not_found |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is DecisionCaseList.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of DecisionCase | yes | The decision cases of this page, newest first. |
has_more | boolean | yes | True when a further page exists. |
next_cursor | string or null | yes | The cursor of the next page, or null on the last page. |
object | "list" | yes |