Read a decision corpus
GET /v1/agents/{agent_id}/decision-corpora/{corpus_id}
Property Value Operation get_decision_corpusGroup Decision corpora Scope agents:readRoute class readIdempotency No Idempotency-Key Audit Not audited: A metadata read; a corpus holds no case content. Released in 1.58.0 Phase 0 host Served (the hosted api pins 1.65.0)
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 Node.js Python
curl "$VOCAL_API/v1/agents/agt_.../decision-corpora/dcp_..." \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/agents/agt_.../decision-corpora/dcp_...`, {
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_...",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
Name In Type Required Description agent_idpath AgentId yes The id of an Agent: agt_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. corpus_idpath DecisionCorpusId yes The id of a decision corpus: dcp_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
Responses
Fields of the 200 answer
The shape is DecisionCorpus .
Field Type Required Description agent_idAgentId yes archived_atTimestamp or nullyes case_countinteger yes created_atTimestamp yes descriptionstring or null yes idDecisionCorpusId yes namestring yes object"decision_corpus"yes question_setQuestionSetKey yes revisioninteger yes The ETag; required in If-Match. updated_atTimestamp yes versioninteger yes Rises by one with each case added or deleted; a run records the version it read.