Read every layer of the Agent draft's settings and the resolved block
GET /v1/agents/{agent_id}/settings
Property Value Operation get_agent_settingsGroup Agents Scope agents:readRoute class readIdempotency No Idempotency-Key Audit Not audited: A configuration read; settings are not Call content. Released in 1.9.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_.../settings" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/agents/agt_.../settings`, {
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_.../settings",
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 AgentSettingsView .
Field Type Required Description agent_idAgentId yes layersobject yes layers.agentAgentSettings yes layers.organizationobject yes layers.organization.boundsarray of OrganizationSettingBound no The Organization's bounds (1.18.0); absent means none. layers.organization.locksarray of SettingPath no The paths the Organization locks (1.18.0); absent means none. layers.organization.valuesAgentSettings yes layers.organization.versioninteger yes layers.platformobject yes layers.platform.entriesarray of PlatformEntry yes The entries that match the draft's stages, least specific scope first. layers.platform.versioninteger yes object"agent_settings"yes resolvedResolvedSettings yes revisioninteger yes The draft revision the view reads.