Skip to main content
GET
/
v1
/
agents
List Agents
curl --request GET \
  --url https://api.oneinbox.ai/v1/agents \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "llm_id": "<string>",
      "webhook_id": "<string>",
      "transcriber": {},
      "tts": {},
      "first_message": "<string>",
      "end_call_phrases": [
        "<string>"
      ],
      "max_duration_seconds": 123,
      "interruption_sensitivity": 123,
      "silence_timeout_seconds": 123,
      "enable_recording": true,
      "language": "<string>",
      "dynamic_variables": {},
      "voicemail_detection": true,
      "voicemail_message": "<string>",
      "responsiveness": 123,
      "speed": 123,
      "background_sound": "<string>",
      "emotions": true,
      "job_description": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "effective_system_prompt": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Your API key sent as a Bearer credential — Authorization: Bearer <api_key>, where <api_key> starts with oi_sk_ (create one via POST /v1/api-keys). Although the field is labelled 'token', paste your API key here. A dashboard JWT is also accepted on this header for the same endpoints.

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

items
AgentResponse · object[]
required
total
integer
required
limit
integer
required
offset
integer
required