List Citation Schemas
curl --request GET \
--url https://api.bland.ai/v1/citation_schemas/list \
--header 'authorization: <authorization>'import requests
url = "https://api.bland.ai/v1/citation_schemas/list"
headers = {"authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<authorization>'}};
fetch('https://api.bland.ai/v1/citation_schemas/list', 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/v1/citation_schemas/list",
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/v1/citation_schemas/list"
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/v1/citation_schemas/list")
.header("authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v1/citation_schemas/list")
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{
"status": 200,
"data": [
{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"name": "Customer Information Extraction",
"description": "Extracts customer demographics and contact information from call transcripts",
"schema": {
"variables": [
{
"name": "Customer Name",
"description": "The full name of the customer",
"type": "string"
},
{
"name": "Customer Age",
"description": "The age of the customer in years",
"type": "number"
}
],
"groupings": [
{
"name": "Demographics",
"variables": ["Customer Name", "Customer Age"]
}
],
"conditions": []
},
"created_at": "2023-12-15T14:30:00.000Z"
},
{
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"name": "Lead Qualification Schema",
"description": "Identifies qualified leads and their interest levels",
"schema": {
"variables": [
{
"name": "Qualified Lead",
"description": "Whether the caller meets qualification criteria",
"type": "boolean"
}
],
"groupings": [],
"conditions": []
},
"created_at": "2023-12-10T09:15:30.000Z"
}
],
"errors": null
}
Citation Schemas
List Citation Schemas
Retrieve all citation schemas for your organization, including each schema’s variables, groupings, and conditions.
GET
/
v1
/
citation_schemas
/
list
List Citation Schemas
curl --request GET \
--url https://api.bland.ai/v1/citation_schemas/list \
--header 'authorization: <authorization>'import requests
url = "https://api.bland.ai/v1/citation_schemas/list"
headers = {"authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<authorization>'}};
fetch('https://api.bland.ai/v1/citation_schemas/list', 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/v1/citation_schemas/list",
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/v1/citation_schemas/list"
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/v1/citation_schemas/list")
.header("authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v1/citation_schemas/list")
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{
"status": 200,
"data": [
{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"name": "Customer Information Extraction",
"description": "Extracts customer demographics and contact information from call transcripts",
"schema": {
"variables": [
{
"name": "Customer Name",
"description": "The full name of the customer",
"type": "string"
},
{
"name": "Customer Age",
"description": "The age of the customer in years",
"type": "number"
}
],
"groupings": [
{
"name": "Demographics",
"variables": ["Customer Name", "Customer Age"]
}
],
"conditions": []
},
"created_at": "2023-12-15T14:30:00.000Z"
},
{
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"name": "Lead Qualification Schema",
"description": "Identifies qualified leads and their interest levels",
"schema": {
"variables": [
{
"name": "Qualified Lead",
"description": "Whether the caller meets qualification criteria",
"type": "boolean"
}
],
"groupings": [],
"conditions": []
},
"created_at": "2023-12-10T09:15:30.000Z"
}
],
"errors": null
}
Headers
string
required
Your API key for authentication.
Response
integer
HTTP status code (200 for success).
array
An array of citation schema objects.
string
The unique identifier for the citation schema (UUID format).
string
The name of the citation schema.
string
The description of the citation schema.
object
The JSON schema configuration containing variables, groupings, and conditions for citation extraction. Returned inline so you can enumerate fields without a follow-up request per schema.
string
The timestamp when the citation schema was created (ISO 8601 format).
null
Will be null for successful requests.
{
"status": 200,
"data": [
{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"name": "Customer Information Extraction",
"description": "Extracts customer demographics and contact information from call transcripts",
"schema": {
"variables": [
{
"name": "Customer Name",
"description": "The full name of the customer",
"type": "string"
},
{
"name": "Customer Age",
"description": "The age of the customer in years",
"type": "number"
}
],
"groupings": [
{
"name": "Demographics",
"variables": ["Customer Name", "Customer Age"]
}
],
"conditions": []
},
"created_at": "2023-12-15T14:30:00.000Z"
},
{
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"name": "Lead Qualification Schema",
"description": "Identifies qualified leads and their interest levels",
"schema": {
"variables": [
{
"name": "Qualified Lead",
"description": "Whether the caller meets qualification criteria",
"type": "boolean"
}
],
"groupings": [],
"conditions": []
},
"created_at": "2023-12-10T09:15:30.000Z"
}
],
"errors": null
}
Docs for agents: llms.txt
Was this page helpful?
⌘I