v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-02172186551.1 KB

Agents

Update agent

Update an AI agent's configuration.

patch/v1/senders/{senderId}/agent

Path parameters

senderIdstring required

Request body

namestring

enabledboolean

provider'openai' | 'anthropic' | 'google' | 'mistral' | 'zavu'

LLM provider for the AI agent.

modelstring

systemPromptstring

apiKeystring

contextWindowMessagesinteger

includeContactMetadataboolean

maxTokensinteger nullable

temperaturenumber nullable

triggerOnChannelsstring[]

triggerOnMessageTypesstring[]

Example request

{
  "voice": {
    "greeting": "Hi, thanks for calling Acme. How can I help you today?",
    "greetings": {
      "es": "Hola, soy Atlas. Preguntame lo que quieras."
    },
    "language": "en",
    "model": "openai/gpt-4o",
    "ttsVoiceId": "aria",
    "transferPhoneNumber": "+14155551234"
  }
}

Response

Agent updated.

Example response

{
  "agent": {
    "id": "agent_abc123",
    "senderId": "sender_12345",
    "name": "Customer Support Agent",
    "model": "gpt-4o-mini",
    "triggerOnChannels": [
      "sms",
      "whatsapp"
    ],
    "triggerOnMessageTypes": [
      "text"
    ],
    "voice": {
      "greeting": "Hi, thanks for calling Acme. How can I help you today?",
      "greetings": {
        "es": "Hola, soy Atlas. Preguntame lo que quieras."
      },
      "language": "en",
      "model": "openai/gpt-4o",
      "ttsVoiceId": "aria",
      "transferPhoneNumber": "+14155551234"
    }
  }
}