Get a voice agent
The agent as stored, without its signing secret.
id*stringThe agent id, such as agent_9f2ab000-0000-4000-8000-000000000001
x-profile-id?stringProfile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.
uuidThe agent
application/json- response
Standard API response envelope for all v3 endpoints
success?booleanIndicates whether the request was successful
data?|nullThe response data (null if error)
error?|nullError details (null if successful)
meta?Metadata about the request and response
curl -X GET 'https://api.sent.dm/v3/voice/agents/string'{ "success": true, "data": { "id": "string", "name": "string", "session_type": "string", "websocket_url": "string", "speech": { "setting": "string", "voice": "string", "language": "string" }, "audio": { "sample_rate": 0 }, "greeting": "string", "tools": [ "string" ], "transfer_targets": [ { "kind": "string", "value": "string" } ], "fallback": { "kind": "string", "value": "string" }, "limits": { "max_call_seconds": 0, "max_concurrent_calls": 0, "allowed_countries": [ "string" ] }, "transcripts": { "store": true, "retention_days": 0 }, "signing_secret": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "error": { "code": "string", "message": "string", "details": { "property1": [ "string" ], "property2": [ "string" ] }, "doc_url": "string" }, "meta": { "request_id": "string", "timestamp": "2019-08-24T14:15:22Z", "version": "string" }}List your voice agents GET
Your voice agents, newest first. `page` and `page_size` (1 to 100, default 20) page the list. Signing secrets are never listed.
Change a voice agent PATCH
Changes the fields you name and answers with the agent as stored, the same shape `GET` returns. A key left out is left alone. A key sent as `null` clears an optional field (`websocket_url` makes the agent dial in, `greeting` and `fallback` go, `speech`, `audio`, `tools`, `limits` and `transcripts` return to their defaults). A key sent with a value replaces that field whole: send the whole `limits` object, not one of its keys. Changing `session_type` drops `speech`, `audio` and `greeting` unless the body sends them, since the other type cannot carry them. The result is checked like a new agent, and a body that changes nothing is `400`. With `sandbox: true` nothing is written: the request is validated against the stored agent and the agent is reported with `200` as it would read after the change.