Skip to main content
GET
/
v1
/
agents
/
{agent_id}
Get Agent
curl --request GET \
  --url https://api.oneinbox.ai/v1/agents/{agent_id} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
}

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.

Path Parameters

​
agent_id
string<uuid>
required

Response

Successful Response

​
id
string
required
​
name
string
required
​
llm_id
string
required
​
webhook_id
string | null
required
​
transcriber
Transcriber · object
required
​
tts
Tts · object
required
​
first_message
string | null
required
​
end_call_phrases
string[]
required
​
max_duration_seconds
integer
required
​
interruption_sensitivity
number
required
​
silence_timeout_seconds
integer
required
​
enable_recording
boolean
required
​
language
string
required
​
dynamic_variables
Dynamic Variables · object
required
​
voicemail_detection
boolean
required
​
voicemail_message
string | null
required
​
responsiveness
number
required
​
speed
number
required
​
background_sound
string | null
required
​
emotions
boolean
required
​
job_description
string | null
required
​
metadata
Metadata · object
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
effective_system_prompt
string | null

Read-only. The system prompt the agent is actually given at call time: the linked LLM model's system_prompt with job_description prepended as a # Role block — exactly as the worker assembles it. Per-call dynamic-variable interpolation and knowledge-base chunks are resolved at runtime and not reflected here. Populated on GET /v1/agents/{id}; null on list responses.