Skip to main content
GET
/
agents
/
{agent_id}
/
bootstrap
Bootstrap Agent
curl --request GET \
  --url https://api.example.com/agents/{agent_id}/bootstrap \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/agents/{agent_id}/bootstrap"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/agents/{agent_id}/bootstrap', 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.example.com/agents/{agent_id}/bootstrap",
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.example.com/agents/{agent_id}/bootstrap"

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))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/agents/{agent_id}/bootstrap")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/{agent_id}/bootstrap")

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
{
  "etag": "<string>",
  "snapshot_at": "2023-11-07T05:31:56Z",
  "agent": {},
  "workflow": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "nodes": "<unknown>",
    "edges": "<unknown>",
    "global_nodes": null,
    "status": "<string>"
  },
  "tools": [
    {
      "id": "<string>",
      "tool_key": "<string>",
      "instance_name": "<string>",
      "display_name": "<string>",
      "enabled": true,
      "config": {},
      "description": "<string>",
      "tool_type": "<string>",
      "version": 123
    }
  ],
  "transfer_targets": [
    {
      "id": "<string>",
      "name": "<string>",
      "target": "<string>",
      "mode": "<string>",
      "sip_trunk_id": "<string>",
      "sip_headers": {},
      "briefing_prompt": "<string>",
      "transfer_announcement": "<string>",
      "tags": [
        "<string>"
      ]
    }
  ],
  "available_specialists": [
    {
      "persona_id": "<string>",
      "specialist_type": "<string>",
      "display_name": "<string>",
      "description": "<string>",
      "agent_id": "<string>",
      "agent_name": "<string>",
      "config_overrides": {}
    }
  ],
  "tool_connections": [
    {}
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

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

Successful Response

Read-only snapshot of an agent's full runtime configuration.

etag
string
required
snapshot_at
string<date-time>
required
agent
Agent · object
required
workflow
BootstrapWorkflow · object | null
required
tools
BootstrapToolInstance · object[]
required
transfer_targets
BootstrapTransferTarget · object[]
required
available_specialists
BootstrapSpecialist · object[]
required
tool_connections
Tool Connections · object[]
required