Read an Agent draft
GET /v1/agents/{agent_id}
Property Value Operation get_agentGroup Agents Scope agents:readRoute class readIdempotency No Idempotency-Key Audit Not audited: A metadata read; Agent configuration is not Call content. Released in 1.0.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_..." \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/agents/agt_...`, {
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_...",
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.
Responses
Fields of the 200 answer
The shape is Agent .
Field Type Required Description active_versioninteger or null yes The version new Calls run, or null when none is active. configAgentConfig yes created_atTimestamp yes descriptionstring or null yes A free-text description. evaluation_gateAgentEvaluationGate or nullno The publish gate the Agent's owner turned on (1.63.0); null when none. Absent from an api before 1.63.0, which a reader treats as null. idAgentId yes latest_versioninteger or null yes The highest published version, or null before the first publish. namestring yes A display name. object"agent"yes revisioninteger yes Counts writes to the draft; returned as the ETag and required in If-Match. updated_atTimestamp yes