Get Citation Schema
curl --request GET \
--url https://api.bland.ai/v1/citation_schemas/ \
--header 'authorization: <authorization>'import requests
url = "https://api.bland.ai/v1/citation_schemas/"
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/', 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/",
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/"
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/")
.header("authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v1/citation_schemas/")
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": "550e8400-e29b-41d4-a716-446655440000",
"name": "Customer Information Extraction",
"description": "Extracts customer demographics and contact information from call transcripts",
"org_id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
"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"
},
{
"name": "Interested in Product",
"description": "Whether the customer expressed interest in the product",
"type": "boolean"
}
],
"groupings": [
{
"name": "Demographics",
"variables": ["Customer Name", "Customer Age"]
}
],
"conditions": [
{
"condition": {
"value": "true",
"operator": "===",
"variable": "Interested in Product"
},
"variables": [
{
"name": "Product Interest Details",
"type": "string",
"description": "Specific details about which product features interest the customer"
}
]
}
]
},
"created_at": "2023-12-15T14:30:00.000Z"
},
"errors": null
}
Citation Schemas
Get Citation Schema
Retrieve a specific citation schema by ID.
GET
/
v1
/
citation_schemas
/
Get Citation Schema
curl --request GET \
--url https://api.bland.ai/v1/citation_schemas/ \
--header 'authorization: <authorization>'import requests
url = "https://api.bland.ai/v1/citation_schemas/"
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/', 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/",
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/"
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/")
.header("authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v1/citation_schemas/")
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": "550e8400-e29b-41d4-a716-446655440000",
"name": "Customer Information Extraction",
"description": "Extracts customer demographics and contact information from call transcripts",
"org_id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
"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"
},
{
"name": "Interested in Product",
"description": "Whether the customer expressed interest in the product",
"type": "boolean"
}
],
"groupings": [
{
"name": "Demographics",
"variables": ["Customer Name", "Customer Age"]
}
],
"conditions": [
{
"condition": {
"value": "true",
"operator": "===",
"variable": "Interested in Product"
},
"variables": [
{
"name": "Product Interest Details",
"type": "string",
"description": "Specific details about which product features interest the customer"
}
]
}
]
},
"created_at": "2023-12-15T14:30:00.000Z"
},
"errors": null
}
Headers
string
required
Your API key for authentication.
Query Parameters
string
required
The unique identifier of the citation schema to retrieve.
Response
integer
HTTP status code (200 for success).
object
The citation schema object.
string
The unique identifier for the citation schema (UUID format).
string
The name of the citation schema.
string
The description of the citation schema.
string
The organization ID that owns this schema.
object
The JSON schema configuration containing variables, groupings, and conditions for citation extraction.
string
The timestamp when the citation schema was created (ISO 8601 format).
null
Will be null for successful requests.
Error Responses
Returned when the schema ID parameter is missing.
Returned when the specified citation schema is not found or doesn’t belong to your organization.
{
"status": 200,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Customer Information Extraction",
"description": "Extracts customer demographics and contact information from call transcripts",
"org_id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
"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"
},
{
"name": "Interested in Product",
"description": "Whether the customer expressed interest in the product",
"type": "boolean"
}
],
"groupings": [
{
"name": "Demographics",
"variables": ["Customer Name", "Customer Age"]
}
],
"conditions": [
{
"condition": {
"value": "true",
"operator": "===",
"variable": "Interested in Product"
},
"variables": [
{
"name": "Product Interest Details",
"type": "string",
"description": "Specific details about which product features interest the customer"
}
]
}
]
},
"created_at": "2023-12-15T14:30:00.000Z"
},
"errors": null
}
Docs for agents: llms.txt
Was this page helpful?
⌘I