Read a case of a decision corpus

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

Answers one case with its state (1.58.0), an audited content read. 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/dcs_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/agents/agt_.../decision-corpora/dcp_.../cases/dcs_...`, {
  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/dcs_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is DecisionCase.