v51

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

List agents

Every agent in the project, newest first — including agents that are not connected to any sender yet, which the sender-scoped routes cannot reach. Each item carries senderIds, the senders the agent answers on.

get/v1/agents

Query parameters

limitinteger
cursorstring

Response

List of agents.

nextCursorstring nullable

Example response

{
  "items": [
    {
      "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"
      }
    }
  ]
}