Skip to main content
POST
Create Citation Schema

Overview

Create a citation schema to define what data should be extracted from call transcripts. Citation schemas allow you to automatically capture structured information like customer details, call outcomes, or any custom variables relevant to your use case.

Headers

authorization
string
required
Your API key for authentication.

Body Parameters

name
string
required
The name of the citation schema. This should be descriptive and help you identify the schema’s purpose.
description
string
An optional description explaining what this schema extracts and its intended use case.
schema
object
The JSON schema configuration that defines variables, groupings, and conditions for citation extraction. If not provided, an empty schema will be created that can be configured later.The schema object can contain:
  • variables: Array of variable definitions for data extraction
  • groupings: Array of related variable collections
  • conditions: Array of conditional logic rules that trigger additional variable extraction
Example structure:

Response

status
integer
HTTP status code (200 for success).
data
object
The created citation schema object.
id
string
The unique identifier for the created citation schema (UUID format).
name
string
The name of the citation schema.
description
string
The description of the citation schema.
org_id
string
The organization ID that owns this schema.
schema
object
The JSON schema configuration for citation extraction.
created_at
string
The timestamp when the citation schema was created (ISO 8601 format).
errors
null
Will be null for successful requests.

Error Responses

400 Bad Request
Returned when the required name parameter is missing.

Docs for agents: llms.txt