Update agent

Partial update — every field on the body is optional and only supplied keys are written.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Human-readable display name. Does not need to be unique — agents are identified by id.

Length1 <= length <= 120

systemPrompt?string

Length1 <= length

voice?string

intent?

Routing defaults stored on an agent row. Hydrated into a session's RoutingIntent when the session is created with agentId and no inline intent. Note: agents accept a smaller optimizeFor enum than the per-session RoutingIntent.

llmOptions?

Optional LLM tuning defaults stored on an agent. Strict object — only these three keys are accepted.

stackPreferences?

Per-agent stack preferences. Empty / missing layers leave the router unconstrained for that layer; failover stays active within the allowed set.

turnHandling?|

Replaces the stored posture wholesale — supplied keys are not merged into the existing object. null clears it back to the platform defaults.

audioOutput?

Static gain in dB on the agent's own speech, applied before the audio reaches the call (and so before a phone leg), whichever TTS provider spoke. Negative is quieter: -6 roughly halves the amplitude, for voices mastered hotter than telephone speech. Boost saturates at full scale, so it clips a voice that already peaks near 0 dBFS. 0 is a passthrough. Background audio is not affected. Send null to remove the gain.

backgroundAudio?

endCall?

firstMessage?string

Lengthlength <= 2000

idleRePrompts?

inboundFirstMessage?string

Lengthlength <= 2000

languageRouting?

outboundFirstMessage?string

Lengthlength <= 2000

promptVariables?array<>

Itemsitems <= 100

runMode?string

Value in"cascade" | "s2s"

graphClassifier?string

Which judge answers llm edge conditions in graph mode. llm (the default) runs a temperature-0 one-shot on this agent's own cascade model. jev routes the decision through TypeSafe's System One as a choice over the candidate edges, returning a calibrated confidence per branch. Ignored by agents with no graph. gpt-live walks the graph on the agent's own GPT-Live speech-to-speech session; a call that runs on the cascade judges with llm. Any failure of the jev judge falls back to the llm path rather than failing the call.

Default"llm"

Value in"llm" | "jev" | "gpt-live"

runtime?string

Managed-agent runtime. Omit it: the runtime that actually serves the agent is chosen for the whole organization, and agent responses carry that effective value, never the value sent here. A value sent here is stored on the agent without changing the organization's runtime, and while the stored value is pipecat, runMode: s2s is refused with 400 INCOMPATIBLE_RUNTIME_MODE (the pipecat runtime runs runMode: cascade only).

Value in"livekit" | "pipecat"

speechNormalization?

sttMissRecovery?

sttOptions?

timezone?string

Length1 <= length <= 64

ttsOptions?

voiceInstructions?string

Lengthlength <= 2000

webhooks?

extractionFields?array<>

Itemsitems <= 30

Response Body

`application/json`

{
  "id": "agent_01HW...",
  "organizationId": "string",
  "name": "string",
  "systemPrompt": "string",
  "voice": "string",
  "intent": {
    "language": "en-US",
    "optimizeFor": "latency"
  },
  "llmOptions": {
    "temperature": 0,
    "maxTokens": 1,
    "model": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "stackPreferences": {
    "allowedProviders": {
      "stt": [
        "deepgram"
      ],
      "llm": [
        "openai"
      ],
      "tts": [
        "elevenlabs"
      ],
      "s2s": [
        "openai:gpt-realtime-2.1"
      ]
    }
  },
  "turnHandling": {
    "profile": "conversational",
    "endpointing": {
      "minDelay": 0,
      "maxDelay": 0
    },
    "interruption": {
      "mode": "adaptive",
      "minDuration": 0,
      "minWords": 0
    },
    "turnDetection": true,
    "contextThreshold": true,
    "dtmfToolDescription": "string",
    "amdPrompt": "string",
    "waitForCallee": true,
    "onMachine": "hangup",
    "voicemailMessage": "string"
  }
}

{
  "error": "Invalid request body",
  "code": "VALIDATION_ERROR"
}

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

{
  "error": "not found",
  "code": "NOT_FOUND"
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`