List your voice agents

Your voice agents, newest first. page and page_size (1 to 100, default 20) page the list. Signing secrets are never listed.

GET
/v3/voice/agents

Response Body

application/json

application/json

curl -X GET "https://example.com/v3/voice/agents?page=0&page_size=0"
{
  "success": true,
  "data": {
    "agents": [
      {
        "id": "string",
        "name": "string",
        "session_type": "string",
        "websocket_url": "string",
        "speech": {
          "setting": "string",
          "voice": "string",
          "language": "string"
        },
        "audio": {
          "sample_rate": 0
        },
        "greeting": "string",
        "tools": [
          "string"
        ],
        "transfer_targets": [
          {
            "kind": "string",
            "value": "string"
          }
        ],
        "fallback": {
          "kind": "string",
          "value": "string"
        },
        "limits": {
          "max_call_seconds": 0,
          "max_concurrent_calls": 0,
          "allowed_countries": [
            "string"
          ]
        },
        "transcripts": {
          "store": true,
          "retention_days": 0
        },
        "signing_secret": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      }
    ],
    "pagination": {
      "page": 0,
      "page_size": 0,
      "total_count": 0,
      "total_pages": 0,
      "has_more": true,
      "cursors": {
        "after": "string",
        "before": "string"
      }
    }
  },
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "doc_url": "string"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "version": "string"
  }
}
{
  "success": true,
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "doc_url": "string"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "version": "string"
  }
}
Empty
Empty

Create a voice agent POST

Creates an agent that answers phone calls through the Sent Voice Gateway. `session_type` says whether Sent carries the call as text (the caller's speech recognised for the agent, the agent's text spoken) or as audio. With `websocket_url` the gateway dials your agent for each call and signs the handshake with the `signing_secret` this response returns; without it, your agent dials in with your API key and this agent's `id`. `tools`, `transfer_targets`, `fallback` and `limits` say what the agent may do on a call. Voices and languages for text sessions come from `GET /v3/voice/voices`. Calls reach the agent once a number is bound to it on `/v3/channels/voice`. `signing_secret` is shown here and on `POST /v3/voice/agents/{id}/rotate-secret` only; store it now. With `sandbox: true` the request is validated and the agent reported with `202`; nothing is written.

Get a voice agent GET

The agent as stored, without its signing secret.