Get All Voice AI Agent Executions API

cURL

curl --request GET \
  --url https://api.bolna.ai/agent/{agent_id}/executions \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "4c06b4d1-4096-4561-919a-4f94539c8d4a",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "batch_id": "baab7cdc833145bf8dd260ff1f0a3f21",
    "conversation_time": 123,
    "total_cost": 123,
    "status": "completed",
    "error_message": "<string>",
    "answered_by_voice_mail": true,
    "transcript": "<string>",
    "created_at": "2024-01-23T01:14:37Z",
    "updated_at": "2024-01-29T18:31:22Z",
    "cost_breakdown": {
      "llm": 4.2,
      "network": 1.2,
      "platform": 2,
      "synthesizer": 6.8,
      "transcriber": 0.7
    },
    "telephony_data": {
      "duration": 42,
      "to_number": "+10123456789",
      "from_number": "+19876543007",
      "recording_url": "https://bolna-call-recordings.s3.us-east-1.amazonaws.com/AC1f3285e7c353c7d4036544f8dac36b98/REb1c182ccde4ddf7969a511a267d3c669",
      "hosted_telephony": true,
      "provider_call_id": "CA42fb13614bfcfeccd94cf33befe14s2f",
      "call_type": "outbound",
      "provider": "twilio",
      "hangup_by": "Caller",
      "hangup_reason": "Normal Hangup",
      "hangup_provider_code": 4000
    },
    "transfer_call_data": {
      "provider_call_id": "CA42fb13614bfcfeccd94cf33befe14s2f",
      "status": "completed",
      "duration": 42,
      "cost": 123,
      "to_number": "+10123456789",
      "from_number": "+19876543007",
      "recording_url": "https://bolna-call-recordings.s3.us-east-1.amazonaws.com/AC1f3285e7c353c7d4036544f8dac36b98/REb1c182ccde4ddf7969a511a267d3c669",
      "hangup_by": "Caller",
      "hangup_reason": "Normal Hangup",
      "hangup_provider_code": 4000
    },
    "batch_run_details": {
      "status": "completed",
      "created_at": "2024-01-23T01:14:37Z",
      "updated_at": "2024-01-29T18:31:22Z",
      "retried": 0
    },
    "extracted_data": {
      "user_interested": true,
      "callback_user": false,
      "address": "42 world lane",
      "salary_expected": "42 bitcoins"
    },
    "context_details": {}
  }
]

GET

agent

{agent_id}

executions

cURL

curl --request GET \
  --url https://api.bolna.ai/agent/{agent_id}/executions \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "4c06b4d1-4096-4561-919a-4f94539c8d4a",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "batch_id": "baab7cdc833145bf8dd260ff1f0a3f21",
    "conversation_time": 123,
    "total_cost": 123,
    "status": "completed",
    "error_message": "<string>",
    "answered_by_voice_mail": true,
    "transcript": "<string>",
    "created_at": "2024-01-23T01:14:37Z",
    "updated_at": "2024-01-29T18:31:22Z",
    "cost_breakdown": {
      "llm": 4.2,
      "network": 1.2,
      "platform": 2,
      "synthesizer": 6.8,
      "transcriber": 0.7
    },
    "telephony_data": {
      "duration": 42,
      "to_number": "+10123456789",
      "from_number": "+19876543007",
      "recording_url": "https://bolna-call-recordings.s3.us-east-1.amazonaws.com/AC1f3285e7c353c7d4036544f8dac36b98/REb1c182ccde4ddf7969a511a267d3c669",
      "hosted_telephony": true,
      "provider_call_id": "CA42fb13614bfcfeccd94cf33befe14s2f",
      "call_type": "outbound",
      "provider": "twilio",
      "hangup_by": "Caller",
      "hangup_reason": "Normal Hangup",
      "hangup_provider_code": 4000
    },
    "transfer_call_data": {
      "provider_call_id": "CA42fb13614bfcfeccd94cf33befe14s2f",
      "status": "completed",
      "duration": 42,
      "cost": 123,
      "to_number": "+10123456789",
      "from_number": "+19876543007",
      "recording_url": "https://bolna-call-recordings.s3.us-east-1.amazonaws.com/AC1f3285e7c353c7d4036544f8dac36b98/REb1c182ccde4ddf7969a511a267d3c669",
      "hangup_by": "Caller",
      "hangup_reason": "Normal Hangup",
      "hangup_provider_code": 4000
    },
    "batch_run_details": {
      "status": "completed",
      "created_at": "2024-01-23T01:14:37Z",
      "updated_at": "2024-01-29T18:31:22Z",
      "retried": 0
    },
    "extracted_data": {
      "user_interested": true,
      "callback_user": false,
      "address": "42 world lane",
      "salary_expected": "42 bitcoins"
    },
    "context_details": {}
  }
]

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

The unique id of the agent

Response

List of all executions by an agent sorted by last run

string<uuid>

Unique identifier for the execution

Example:

"4c06b4d1-4096-4561-919a-4f94539c8d4a"

agent_id

string<uuid>

Unique id of the agent

batch_id

string

Unique id of the batch

Example:

"baab7cdc833145bf8dd260ff1f0a3f21"

conversation_time

number<float>

Total time duration for the conversation (in seconds)

total_cost

number<float>

Total cost incurred by this execution in cents

status

enum<string>

Current status of the call

Available options:

completed,

call-disconnected,

no-answer,

busy,

failed,

in-progress,

canceled,

balance-low,

queued,

ringing,

initiated

error_message

string

Associated error message (if any)

answered_by_voice_mail

boolean

If the call was answered by voice mail

transcript

string

Transcription of the execution

created_at

string<date-time>

Timestamp of agent execution

Example:

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

updated_at

string<date-time>

Last updated timestamp for the execution

Example:

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

cost_breakdown

object

Breakdown of the costs in cents

Show child attributes

cost_breakdown.llm

number<float>

Total cost incurred by the LLM in cents

Example:

4.2

cost_breakdown.network

number<float>

Total telephony cost in cents

Example:

1.2

cost_breakdown.platform

number<float>

Bolna platform cost in cents

Example:

2

cost_breakdown.synthesizer

number<float>

Total cost incurred by the Synthesizer provider in cents

Example:

6.8

cost_breakdown.transcriber

number<float>

Total cost incurred by the Transcriber provider in cents

Example:

0.7

telephony_data

object

Telephony call data

Show child attributes

telephony_data.duration

string

Total duration of the call in seconds

Example:

42

telephony_data.to_number

string

Phone number of the recipient alongwith country code (in E.164 format)

Example:

"+10123456789"

telephony_data.from_number

string

Phone number of the sender

Example:

"+19876543007"

telephony_data.recording_url

string<uri>

Recording URL for the telephone call

Example:

"https://bolna-call-recordings.s3.us-east-1.amazonaws.com/AC1f3285e7c353c7d4036544f8dac36b98/REb1c182ccde4ddf7969a511a267d3c669"

telephony_data.hosted_telephony

boolean

Whether the call was made using Bolna telephony

telephony_data.provider_call_id

string

Unique ID of the call from the Telephony Provider (like Twilio, Plivo, Vonage, etc.)

Example:

"CA42fb13614bfcfeccd94cf33befe14s2f"

telephony_data.call_type

enum<string>

The call was an incoming or outgoing call

Available options:

outbound,

inbound

telephony_data.provider

enum<string>

The telephony call provider

Available options:

twilio,

plivo

telephony_data.hangup_by

string

Source for call hungup

Example:

"Caller"

telephony_data.hangup_reason

string

Reason of the hungup

Example:

"Normal Hangup"

telephony_data.hangup_provider_code

integer

Provider specific code for hangup

Example:

4000

transfer_call_data

object

Telephony call data

Show child attributes

transfer_call_data.provider_call_id

string

Unique ID of the call from the Telephony Provider (like Twilio, Plivo, Vonage, etc.)

Example:

"CA42fb13614bfcfeccd94cf33befe14s2f"

transfer_call_data.status

enum<string>

Status of this transferred call

Available options:

completed,

call-disconnected,

no-answer,

busy,

failed,

in-progress,

canceled,

balance-low,

queued,

ringing,

initiated

transfer_call_data.duration

string

Total duration of this transferred call in seconds

Example:

42

transfer_call_data.cost

number<float>

Total cost incurred for this transferred call

transfer_call_data.to_number

string

Phone number of the recipient alongwith country code (in E.164 format)

Example:

"+10123456789"

transfer_call_data.from_number

string

Phone number which is making the transfer call

Example:

"+19876543007"

transfer_call_data.recording_url

string<uri>

Recording URL for the transferred call

Example:

"https://bolna-call-recordings.s3.us-east-1.amazonaws.com/AC1f3285e7c353c7d4036544f8dac36b98/REb1c182ccde4ddf7969a511a267d3c669"

transfer_call_data.hangup_by

string

Source for transfer call hungup

Example:

"Caller"

transfer_call_data.hangup_reason

string

Reason of the transfer call hungup

Example:

"Normal Hangup"

transfer_call_data.hangup_provider_code

integer

Provider specific code for transfer call hangup

Example:

4000

batch_run_details

object

Batch information

Show child attributes

batch_run_details.status

enum<string>

Status of the call initiated using batch

Available options:

completed,

call-disconnected,

no-answer,

busy,

failed,

in-progress,

canceled,

balance-low,

queued,

ringing,

initiated

Example:

"completed"

batch_run_details.created_at

string<date-time>

Timestamp of the execution created by the batch

Example:

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

batch_run_details.updated_at

string<date-time>

Last updated timestamp for the execution

Example:

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

batch_run_details.retried

number<integer>

Number of retries made by the batch after initial attempt

Example:

0

extracted_data

object

Extracted data in JSON format which was mentioned in the agent extraction_prompt

Example:

{
  "user_interested": true,
  "callback_user": false,
  "address": "42 world lane",
  "salary_expected": "42 bitcoins"
}

context_details

object

Custom variable data injected in the call

List agents

⌘I

API Documentation

Current APIs

Legacy APIs

Get All Voice AI Agent Executions API

Authorizations

Path Parameters

Response