VocalDocscontracts 1.65.0

Read every layer of the Agent draft's settings and the resolved block

GET /v1/agents/{agent_id}/settings

PropertyValue
Operationget_agent_settings
GroupAgents
Scopeagents:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; settings are not Call content.
Released in1.9.0
Phase 0 hostServed (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 "$VOCAL_API/v1/agents/agt_.../settings" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
agent_idpathAgentIdyesThe id of an Agent: agt_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.

Responses

StatusContent typeShapeError codes
200application/jsonAgentSettingsView
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is AgentSettingsView.

FieldTypeRequiredDescription
agent_idAgentIdyes
layersobjectyes
layers.agentAgentSettingsyes
layers.organizationobjectyes
layers.organization.boundsarray of OrganizationSettingBoundnoThe Organization's bounds (1.18.0); absent means none.
layers.organization.locksarray of SettingPathnoThe paths the Organization locks (1.18.0); absent means none.
layers.organization.valuesAgentSettingsyes
layers.organization.versionintegeryes
layers.platformobjectyes
layers.platform.entriesarray of PlatformEntryyesThe entries that match the draft's stages, least specific scope first.
layers.platform.versionintegeryes
object"agent_settings"yes
resolvedResolvedSettingsyes
revisionintegeryesThe draft revision the view reads.