Agents

Create a standalone agent

Changed on

Create an agent without a sender. It is created disabled; connect a sender and enable it when you are ready for it to answer.

Sub-resources. An agent's tools, flows and knowledge bases are reachable at /v1/agents/{agentId}/tools, /v1/agents/{agentId}/flows and /v1/agents/{agentId}/knowledge-bases, mirroring the sender-scoped routes documented under /v1/senders/{senderId}/agent/... exactly. Use the agent-scoped form while the agent has no sender: the sender-scoped one cannot address it.

post/v1/agents

Request

  • Base URL
    https://api.zavu.dev
  • URL
    https://api.zavu.dev/v1/agents
  • Auth
    HTTP bearer

Request body

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

LLM provider for the AI agent.

modelstring required
systemPromptstring required
apiKeystring

API key for the LLM provider. Required unless provider is 'zavu'. Stored encrypted and never returned.

contextWindowMessagesinteger
includeContactMetadataboolean
triggerOnChannelsstring[]
triggerOnMessageTypesstring[]
maxTokensinteger
temperaturenumber

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

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"
    }
  }
}

Changes