Retrieve voice AI agent execution API

GET

agent

{agent_id}

execution

{execution_id}

cURL

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

import requests

url = "https://api.bolna.ai/agent/{agent_id}/execution/{execution_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.bolna.ai/agent/{agent_id}/execution/{execution_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bolna.ai/agent/{agent_id}/execution/{execution_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bolna.ai/agent/{agent_id}/execution/{execution_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bolna.ai/agent/{agent_id}/execution/{execution_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "4c06b4d1-4096-4561-919a-4f94539c8d4a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batch_id": "baab7cdc833145bf8dd260ff1f0a3f21",
  "conversation_duration": 123,
  "total_cost": 123,
  "status": "scheduled",
  "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,
    "ring_duration": 17,
    "post_dial_delay": 1,
    "to_number_carrier": "Reliance Jio Infocomm Ltd (RJIL)"
  },
  "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
  },
  "summary": "<string>",
  "extracted_data": {
    "user_interested": true,
    "callback_user": false,
    "address": "42 world lane",
    "salary_expected": "42 bitcoins"
  },
  "node_extracted_data": {
    "availability": "Yes",
    "callback_hour": 18
  },
  "context_details": {}
}

{
  "error": 123,
  "message": "<string>"
}

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

execution_id

string<uuid>

required

The unique execution_id by the agent

Response

Retrieve specific execution by an agent

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

Pattern: ^[a-f0-9]{32}$

Example:

"baab7cdc833145bf8dd260ff1f0a3f21"

conversation_duration

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. Typical progression: queued → initiated → ringing → in-progress → call-disconnected → completed. Important: call-disconnected fires the instant the line drops, before duration, cost, recording URL, and extracted_data are finalized. The true terminal state is completed (or no-answer, busy, failed, canceled, stopped, error, balance-low). Always wait for completed before reading those fields.

Available options:

scheduled,

queued,

rescheduled,

initiated,

ringing,

in-progress,

call-disconnected,

completed,

balance-low,

busy,

no-answer,

canceled,

failed,

stopped,

error

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

telephony_data

object

Telephony call data

Show child attributes

transfer_call_data

object

Telephony call data

Show child attributes

batch_run_details

object

Batch information

Show child attributes

summary

string | null

AI-generated summary of the call. Populated only when the agent's call_summary_enabled toggle is on; null otherwise. The same text also appears in extracted_data under General > Call Summary with only a subjective value.

extracted_data

object | null

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"
}

node_extracted_data

object | null

Graph agents only: the values the agent's edge parameters collected during the call, the latest value per key. null for other agents.

Example:

{
  "availability": "Yes",
  "callback_hour": 18
}

context_details

object

Custom variable data injected in the call. For batch executions, the sub-object context_details.recipient_data contains every non-contact_number column from the uploaded CSV row (e.g. {"customer_name": "Asha", "appointment_day": "Friday"}).

cURL

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

import requests

url = "https://api.bolna.ai/agent/{agent_id}/execution/{execution_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.bolna.ai/agent/{agent_id}/execution/{execution_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bolna.ai/agent/{agent_id}/execution/{execution_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bolna.ai/agent/{agent_id}/execution/{execution_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bolna.ai/agent/{agent_id}/execution/{execution_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "4c06b4d1-4096-4561-919a-4f94539c8d4a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batch_id": "baab7cdc833145bf8dd260ff1f0a3f21",
  "conversation_duration": 123,
  "total_cost": 123,
  "status": "scheduled",
  "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,
    "ring_duration": 17,
    "post_dial_delay": 1,
    "to_number_carrier": "Reliance Jio Infocomm Ltd (RJIL)"
  },
  "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
  },
  "summary": "<string>",
  "extracted_data": {
    "user_interested": true,
    "callback_user": false,
    "address": "42 world lane",
    "salary_expected": "42 bitcoins"
  },
  "node_extracted_data": {
    "availability": "Yes",
    "callback_hour": 18
  },
  "context_details": {}
}

{
  "error": 123,
  "message": "<string>"
}

Get started

Voice agents

Telephony

Workflows

Account

Legacy

Retrieve voice AI agent execution API

Authorizations

Path Parameters

Response