Skip to main content
GET
/
api
/
agents
Get Agents
curl --request GET \
  --url https://api.example.com/api/agents
[
  {
    "id": 123,
    "prompt": "<string>",
    "agent_name": "<string>",
    "agent_phone_number": "<string>",
    "voice_id": "<string>",
    "version": 123,
    "welcome_text": "<string>",
    "enabled": true,
    "save_stats": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "tools": [
      "<unknown>"
    ],
    "provider_type": "EXOTEL",
    "llm_config_json": {},
    "audio_config_json": {},
    "call_settings_json": {},
    "tools_config_json": {},
    "analytics_config_json": {},
    "created_from_template_id": 123,
    "created_from_template_version": 123
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.originsai.ai/llms.txt

Use this file to discover all available pages before exploring further.

Response

200 - application/json

Successful Response

​
id
integer
required
​
prompt
string
required
​
agent_name
string
required
​
agent_phone_number
string
required
​
voice_id
string
required
​
version
integer
required
​
welcome_text
string
required
​
enabled
boolean
required
​
save_stats
boolean
required
​
server_type
enum<string>
required
Available options:
LOCAL,
DEV,
QA,
PROD
​
call_type
enum<string>
required
Available options:
INCOMING,
OUTGOING
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
tools
any[] | null
​
provider_type
enum<string>
default:EXOTEL

Telephony provider types for call agents.

Available options:
EXOTEL,
PLIVO_CX,
PLIVO_L
​
llm_config_json
Llm Config Json · object
​
audio_config_json
Audio Config Json · object
​
call_settings_json
Call Settings Json · object
​
tools_config_json
Tools Config Json · object
​
analytics_config_json
Analytics Config Json · object
​
created_from_template_id
integer | null
​
created_from_template_version
integer | null