SEsentdm
Voice

Change a voice agent

Changed on

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.

patch/v3/voice/agents/{id}

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/voice/agents/{id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

idstring required

The agent id, such as agent_9f2ab000-0000-4000-8000-000000000001

Headers

Idempotency-Keystring

Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.

x-profile-idstring uuid

Profile 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.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

namestring

A new name, 1 to 100 characters.

session_typestring

text or audio. Changing it drops the settings the other type cannot have (speech, audio, greeting) unless the body sends them.

websocket_urlstring nullable

A new wss:// URL, or null for an agent that dials in.

greetingstring nullable

A new greeting, or null for none.

toolsstring[] nullable

The whole list of tools; null restores the default.

Response

The agent as stored after the change

successboolean

Indicates whether the request was successful

Changes