Catalogs
Get Variable Catalog
List the agent variables a disposition can re-extract.
GET
/
v2
/
agents
/
{agent_id}
/
dispositions
/
variable-catalog
Get Variable Catalog
curl --request GET \
--url https://api.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog \
--header 'authorization: <authorization>'import requests
url = "https://api.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog"
headers = {"authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<authorization>'}};
fetch('https://api.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog', 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.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog",
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: <authorization>"
],
]);
$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.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<authorization>")
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.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog")
.header("authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"data": [
{
"key": "callback_number",
"prompt": "The phone number the caller wants us to call back.",
"accurateSpelling": true,
"outputSchema": {
"kind": "string",
"description": "The phone number the caller wants us to call back. Preserve exact character-by-character spelling."
}
},
{
"key": "party_size",
"prompt": "How many people the reservation is for.",
"accurateSpelling": false,
"outputSchema": {
"kind": "number",
"description": "How many people the reservation is for."
}
},
{
"key": "wants_followup",
"prompt": "Whether the caller asked for a follow-up call.",
"accurateSpelling": false,
"outputSchema": {
"kind": "boolean",
"description": "Whether the caller asked for a follow-up call."
}
}
],
"errors": null
}
{
"data": null,
"errors": [
{
"error": "NOT_FOUND",
"message": "Agent not found"
}
]
}
Overview
Dispositions are enabled per organization. If your organization does not have access, these endpoints return
404.string, number, and boolean variables are included; json variables, and variables defined with conflicting prompts or types in different scenarios, are omitted. Entries are sorted by key, and the list is empty if the agent has no saved version.
Headers
string
required
Your API key for authentication.
Path Parameters
string
required
The agent’s unique identifier. A malformed id returns
400 with the message agentId must be a valid UUID.Response
array
Array of variable catalog entries.
Show variable entry
Show variable entry
string
The variable name as defined on the agent. Use it as
variableKey in a disposition value’s variable_extraction source.string
The extraction prompt configured on the agent, trimmed. Empty string when the variable has no prompt.
boolean
true when the variable is configured for exact character-by-character spelling.object
The schema a disposition value should use for this variable.
kind mirrors the variable’s type (string, number, or boolean). description is the prompt, with the sentence Preserve exact character-by-character spelling. appended when accurateSpelling is true; it is omitted when both are empty.null | array
null on success, or a list of error objects if the request failed.{
"data": [
{
"key": "callback_number",
"prompt": "The phone number the caller wants us to call back.",
"accurateSpelling": true,
"outputSchema": {
"kind": "string",
"description": "The phone number the caller wants us to call back. Preserve exact character-by-character spelling."
}
},
{
"key": "party_size",
"prompt": "How many people the reservation is for.",
"accurateSpelling": false,
"outputSchema": {
"kind": "number",
"description": "How many people the reservation is for."
}
},
{
"key": "wants_followup",
"prompt": "Whether the caller asked for a follow-up call.",
"accurateSpelling": false,
"outputSchema": {
"kind": "boolean",
"description": "Whether the caller asked for a follow-up call."
}
}
],
"errors": null
}
{
"data": null,
"errors": [
{
"error": "NOT_FOUND",
"message": "Agent not found"
}
]
}
Docs for agents: llms.txt
Was this page helpful?
⌘I
Get Variable Catalog
curl --request GET \
--url https://api.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog \
--header 'authorization: <authorization>'import requests
url = "https://api.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog"
headers = {"authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<authorization>'}};
fetch('https://api.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog', 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.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog",
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: <authorization>"
],
]);
$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.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<authorization>")
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.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog")
.header("authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v2/agents/{agent_id}/dispositions/variable-catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"data": [
{
"key": "callback_number",
"prompt": "The phone number the caller wants us to call back.",
"accurateSpelling": true,
"outputSchema": {
"kind": "string",
"description": "The phone number the caller wants us to call back. Preserve exact character-by-character spelling."
}
},
{
"key": "party_size",
"prompt": "How many people the reservation is for.",
"accurateSpelling": false,
"outputSchema": {
"kind": "number",
"description": "How many people the reservation is for."
}
},
{
"key": "wants_followup",
"prompt": "Whether the caller asked for a follow-up call.",
"accurateSpelling": false,
"outputSchema": {
"kind": "boolean",
"description": "Whether the caller asked for a follow-up call."
}
}
],
"errors": null
}
{
"data": null,
"errors": [
{
"error": "NOT_FOUND",
"message": "Agent not found"
}
]
}