Skip to main content
GET
/
v2
/
agent
/
{agent_id}
cURL
curl --request GET \
  --url https://api.bolna.ai/v2/agent/{agent_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_name": "Alfred",
  "agent_type": "other",
  "agent_status": "processed",
  "created_at": "2024-01-23T01:14:37Z",
  "updated_at": "2024-01-29T18:31:22Z",
  "tasks": [
    {
      "task_type": "conversation",
      "task_config": {
        "hangup_after_silence": 10,
        "incremental_delay": 400,
        "number_of_words_for_interruption": 2,
        "hangup_after_LLMCall": false,
        "call_cancellation_prompt": null,
        "backchanneling": false,
        "backchanneling_message_gap": 5,
        "backchanneling_start_delay": 5,
        "ambient_noise_track": "coffee-shop",
        "call_terminate": 90,
        "voicemail": false,
        "inbound_limit": -1,
        "whitelist_phone_numbers": null,
        "disallow_unknown_numbers": false
      }
    }
  ],
  "ingest_source_config": {
    "source_type": "api",
    "source_url": "https://example.com/api/data",
    "source_auth_token": "abc123",
    "source_name": "leads_sheet_june.csv"
  },
  "agent_prompts": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agent_id
string<uuid>
required

Response

Agent response

​
id
string<uuid>

Unique identifier for the agent

​
agent_name
string

Human-readable agent name

Example:

"Alfred"

​
agent_type
string

Type of agent

Example:

"other"

​
agent_status
enum<string>

Current status of the agent

Available options:
seeding,
processed
Example:

"processed"

​
created_at
string<date-time>

Timestamp of agent creation

Example:

"2024-01-23T01:14:37Z"

​
updated_at
string<date-time>

Timestamp of last update for the agent

Example:

"2024-01-29T18:31:22Z"

​
tasks
object[]

An array of tasks that the agent can perform

​
ingest_source_config
object

Configuration for ingestion source used for inbound agents. Required fields vary by source_type.

​
agent_prompts
object

Prompts to be provided to the agent. It can have multiple tasks of the form task_<task_id>