Skip to main content
GET
/
agents
/
{agent_id}
Get Agent
curl --request GET \
  --url https://api.prod.usesimple.ai/api/v1/agents/{agent_id} \
  --header 'Authorization: <api-key>'
{
  "prompt": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": 123,
  "user_id": 123,
  "analyzers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompt": "<string>",
      "output_config": {}
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "available_params": [],
  "name": "Agent",
  "first_sentence": "<string>",
  "language": "en",
  "record": true
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
agent_id
string<uuid>
required

Response

Successful Response

​
prompt
string
required
​
id
string<uuid>
required
​
organization_id
integer
required
​
user_id
integer
required
​
analyzers
Analyzers · object[]
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
available_params
string[]
​
name
string
default:Agent
​
first_sentence
string

The first sentence the agent will say when starting a call

​
language
enum<string>

The language the agent uses for calls

Available options:
en,
es
​
record
boolean

Whether the agent's calls are recorded