Pragence

Projects API

POST /api/v1/api/keys

Summary: Create Api Key

Create a new API key for the caller's organization (admin only).

Request Schema (APIKeyCreateRequest):

PropertyTypeRequiredDescription
namestring*Human-readable key name
scopesarray of stringGranted scopes: search, synthesize, chat, admin
key_typestringCredential type: 'secret' (server-side) or 'publishable' (client-safe)
descriptionany
expires_atanyOptional expiry timestamp
rate_limit_per_minuteanyOptional per-minute rate limit

Response Schema (APIKeyCreateResponse - Status 201):

PropertyTypeRequiredDescription
idinteger*
namestring*
descriptionany*
key_prefixstring*
scopesarray of string*
key_typestring*
is_activeboolean*
expires_atany*
last_used_atany*
created_atstring*
api_keystring*Plaintext key — shown only once, store it securely

GET /api/v1/api/keys

Summary: List Api Keys

List active API keys for the caller's organization (masked).


POST /api/v1/api/keys/tokens

Summary: Mint End User Token

Mint a short-lived delegated end-user JWT (on-behalf-of access).

Requires a secret API key (server-side). The returned token scopes the session to org_id + external_user_id so a customer's app can call the public API for its own users without Pragence accounts.

Request Schema (EndUserTokenRequest):

PropertyTypeRequiredDescription
external_user_idstring*The calling app's own end-user identifier
scopesanySubset of the key's scopes (defaults to all)
ttl_secondsanyToken lifetime (default 900s)

Response Schema (EndUserTokenResponse - Status 200):

PropertyTypeRequiredDescription
tokenstring*Short-lived delegated end-user JWT
expires_atstring*

DELETE /api/v1/api/keys/{key_id}

Summary: Revoke Api Key

Revoke (deactivate) an API key.


MCP servers

The /api/v1/api/mcp-servers routes, including per-person sign-in, are documented on MCP servers.


GET /api/v1/branding/themes

Summary: List theme presets

Get all available theme presets for quick branding setup

Response Schema (ThemePresetsResponse - Status 200):

PropertyTypeRequiredDescription
presetsarray of ThemePreset*

POST /api/v1/conversations

Summary: Create Conversation

Create a new conversation.

Supports both registered users and anonymous visitors.

Request Schema (ConversationCreate):

PropertyTypeRequiredDescription
thread_idanyCustom thread ID (generated if not provided)
user_idanyRegistered user ID
anonymous_idanyAnonymous visitor ID
visitor_emailanyVisitor email
visitor_nameany
visitor_phoneany
visitor_locationany
modestringMode
source_urlany
metadataany

Response Schema (ConversationResponse - Status 201):

PropertyTypeRequiredDescription
idstring*
thread_idstring*
org_idstring*
project_idany*
user_idany*
anonymous_idany*
visitor_emailany*
visitor_nameany*
visitor_phoneany*
visitor_locationany*
titleany*
summaryany*
modestring*
statusstring*
message_countinteger*
positive_messagesinteger*
negative_messagesinteger*
overall_sentimentany*
sentiment_scoreany*
detected_toneany*
topicsobject*
tagsarray of string*
source_urlany*
metadataobject*
started_atstring*
last_message_atany*
closed_atany*

GET /api/v1/conversations

Summary: List Conversations

List conversations with filters.

Filters by project, mode, and status.

Response Schema (ConversationListResponse - Status 200):

PropertyTypeRequiredDescription
conversationsarray of ConversationResponse*
totalinteger*
limitinteger*
offsetinteger*

GET /api/v1/conversations/{conversation_id}

Summary: Get Conversation

Get conversation by ID with messages.

Response Schema (ConversationWithMessages - Status 200):

PropertyTypeRequiredDescription
idstring*
thread_idstring*
org_idstring*
project_idany*
user_idany*
anonymous_idany*
visitor_emailany*
visitor_nameany*
visitor_phoneany*
visitor_locationany*
titleany*
summaryany*
modestring*
statusstring*
message_countinteger*
positive_messagesinteger*
negative_messagesinteger*
overall_sentimentany*
sentiment_scoreany*
detected_toneany*
topicsobject*
tagsarray of string*
source_urlany*
metadataobject*
started_atstring*
last_message_atany*
closed_atany*
messagesarray of MessageResponse*

PATCH /api/v1/conversations/{conversation_id}

Summary: Update Conversation

Update conversation metadata.

Request Schema (ConversationUpdate):

PropertyTypeRequiredDescription
titleany
summaryany
statusanyopen, closed, archived
detected_toneany
topicsany
tagsany
metadataany

Response Schema (ConversationResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
thread_idstring*
org_idstring*
project_idany*
user_idany*
anonymous_idany*
visitor_emailany*
visitor_nameany*
visitor_phoneany*
visitor_locationany*
titleany*
summaryany*
modestring*
statusstring*
message_countinteger*
positive_messagesinteger*
negative_messagesinteger*
overall_sentimentany*
sentiment_scoreany*
detected_toneany*
topicsobject*
tagsarray of string*
source_urlany*
metadataobject*
started_atstring*
last_message_atany*
closed_atany*

POST /api/v1/conversations/{conversation_id}/close

Summary: Close Conversation

Close a conversation.

Response Schema (ConversationResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
thread_idstring*
org_idstring*
project_idany*
user_idany*
anonymous_idany*
visitor_emailany*
visitor_nameany*
visitor_phoneany*
visitor_locationany*
titleany*
summaryany*
modestring*
statusstring*
message_countinteger*
positive_messagesinteger*
negative_messagesinteger*
overall_sentimentany*
sentiment_scoreany*
detected_toneany*
topicsobject*
tagsarray of string*
source_urlany*
metadataobject*
started_atstring*
last_message_atany*
closed_atany*

POST /api/v1/conversations/{conversation_id}/messages

Summary: Add Message

Add a message to a conversation.

Request Schema (MessageCreate):

PropertyTypeRequiredDescription
rolestring*Message role: user, assistant, system
contentstring*Message content
query_idanyRAG query ID
citationsany
confidence_scoreany
latency_msany
sentimentanypositive, negative, neutral
sentiment_scoreany
sourceanyknowledge_base or general_knowledge
kb_documents_foundany
metadataany

Response Schema (MessageResponse - Status 201):

PropertyTypeRequiredDescription
idstring*
conversation_idstring*
rolestring*
contentstring*
query_idany*
citationsarray of object*
confidence_scoreany*
latency_msany*
sentimentany*
sentiment_scoreany*
sourceany*
kb_documents_foundany*
feedbackany*
feedback_commentany*
created_atstring*
metadataobject*

GET /api/v1/conversations/{conversation_id}/messages

Summary: Get Messages

Get messages for a conversation.


POST /api/v1/conversations/messages/{message_id}/feedback

Summary: Add Message Feedback

Add feedback to a message.

Request Schema (MessageFeedback):

PropertyTypeRequiredDescription
feedbackstring*positive or negative
commentany

Response Schema (FeedbackResponse - Status 200):

PropertyTypeRequiredDescription
message_idstring*
feedbackstring*
commentany*
created_atstring*

POST /api/v1/conversations/messages/{message_id}/regenerate

Summary: Regenerate Message

Regenerate an assistant message by re-executing the query.

This endpoint:

  1. Finds the user message that preceded this assistant message
  2. Deletes the current assistant message
  3. Re-executes the query to generate a new response
  4. Returns the new assistant message

Request Schema (MessageRegenerateRequest):

PropertyTypeRequiredDescription
collection_idanyOptional collection filter
use_cachebooleanWhether to use cached results

Response Schema (MessageRegenerateResponse - Status 200):

PropertyTypeRequiredDescription
message_idstring*
conversation_idstring*
contentstring*
citationsarray of object*
confidence_scoreany*
latency_msnumber*
created_atstring*

PATCH /api/v1/conversations/messages/{message_id}/edit

Summary: Edit Message

Edit a user message and optionally regenerate the assistant response.

This endpoint:

  1. Updates the user message content
  2. If regenerate_response is True:
    • Finds and deletes the next assistant message
    • Re-executes the query with the new content
    • Returns the new assistant message

Request Schema (MessageEditRequest):

PropertyTypeRequiredDescription
contentstring*New message content
regenerate_responsebooleanWhether to regenerate the assistant response

Response Schema (MessageEditResponse - Status 200):

PropertyTypeRequiredDescription
message_idstring*
contentstring*
updated_atstring*
new_assistant_messageanyNew regenerated response if requested

GET /api/v1/conversations/sitegpt/{conversation_id}/details

Summary: Get Sitegpt Conversation Details

Get detailed conversation view for SiteGPT UI.

Includes chat info, lead info, tickets, and messages.

Response Schema (SiteGPTConversationDetails - Status 200):

PropertyTypeRequiredDescription
conversationConversationResponse*
chat_infoSiteGPTChatInfo*
lead_infoany*
ticketsarray of SiteGPTTicket*
messagesarray of MessageResponse*
total_messagesinteger*
positive_countinteger*
negative_countinteger*
positive_percentagenumber*
negative_percentagenumber*

GET /api/v1/conversations/inbox

Summary: Get Inbox Conversations

Q5: Admin inbox — list conversations with diagnostics summary.

Returns conversations with a quick summary of the latest assistant message's agent diagnostics (critique score, source, feedback status). Reads from the Conversation model only — no LangGraph state access needed.

Response Schema (InboxConversationListResponse - Status 200):

PropertyTypeRequiredDescription
conversationsarray of InboxConversationListItem*
totalinteger*
limitinteger*
offsetinteger*

GET /api/v1/conversations/inbox/{conversation_id}

Summary: Get Inbox Conversation Detail

Q5: Admin inbox — get conversation detail with agent diagnostics per message.

Returns the full conversation with messages, where each assistant message includes agent diagnostics (critique_score, iterations, source, reformulation_triggered, etc.) captured at write-time.

This reads entirely from the Conversation/Message tables. No LangGraph checkpoint access is needed — diagnostics are captured at write-time via the dual-write pattern (Q2).

Response Schema (InboxConversationResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
thread_idstring*
org_idstring*
project_idany*
user_idany*
anonymous_idany*
visitor_emailany*
visitor_nameany*
titleany*
modestring*
statusstring*
message_countinteger*
overall_sentimentany*
source_urlany*
started_atstring*
last_message_atany*
messagesarray of InboxMessageResponse*

POST /api/v1/projects/

Summary: Create Project

Create a new project (organization admin only).

Only organization admins can create new projects.

Request Schema (ProjectCreate):

PropertyTypeRequiredDescription
namestring*Project name
descriptionanyProject description
configanyProject-level configuration overrides
metadataanyAdditional metadata

Response Schema (ProjectResponse - Status 201):

PropertyTypeRequiredDescription
idstring*
namestring*
descriptionany*
org_idstring*
statusstring*
visibilitystring
configobject
metadataobject*
created_atstring*
updated_atstring*
member_countany
document_countany

GET /api/v1/projects/

Summary: List Projects

List projects the current user has access to.

  • Organization admins see all projects in the organization
  • Regular users see only projects they are members of

Response Schema (ProjectListResponse - Status 200):

PropertyTypeRequiredDescription
projectsarray of ProjectResponse*
totalinteger*
pageinteger*
page_sizeinteger*

GET /api/v1/projects/{project_id}

Summary: Get Project

Get project details including members.

User must be a member of the project or an organization admin.

Response Schema (ProjectDetailResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
namestring*
descriptionany*
org_idstring*
statusstring*
visibilitystring
configobject
metadataobject*
created_atstring*
updated_atstring*
member_countany
document_countany
membersarray of ProjectMemberResponse

PATCH /api/v1/projects/{project_id}

Summary: Update Project

Update project details.

Requires project admin role or organization admin.

Request Schema (ProjectUpdate):

PropertyTypeRequiredDescription
nameanyProject name
descriptionanyProject description
statusanyProject status: active or archived
configanyProject-level configuration overrides
metadataanyAdditional metadata

Response Schema (ProjectResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
namestring*
descriptionany*
org_idstring*
statusstring*
visibilitystring
configobject
metadataobject*
created_atstring*
updated_atstring*
member_countany
document_countany

DELETE /api/v1/projects/{project_id}

Summary: Delete Project

Delete a project (archive it).

Requires project owner role or organization admin. This sets the status to 'archived' rather than hard-deleting.


GET /api/v1/projects/{project_id}/members

Summary: List Project Members

List all members of a project.

User must be a member of the project or an organization admin.


POST /api/v1/projects/{project_id}/members

Summary: Add Project Member

Add a member to a project.

Requires project admin role or organization admin.

Request Schema (ProjectMemberCreate):

PropertyTypeRequiredDescription
user_idstring*User ID to add to the project
rolestring*Project role: owner, admin, member, or viewer

Response Schema (ProjectMemberResponse - Status 201):

PropertyTypeRequiredDescription
idstring*
user_idstring*
user_emailany
user_full_nameany
rolestring*
created_atstring*
updated_atstring*

PATCH /api/v1/projects/{project_id}/members/{user_id}

Summary: Update Project Member Role

Update a member's role in a project.

Requires project admin role or organization admin.

Request Schema (ProjectMemberUpdateRole):

PropertyTypeRequiredDescription
rolestring*New project role: owner, admin, member, or viewer

Response Schema (ProjectMemberResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
user_idstring*
user_emailany
user_full_nameany
rolestring*
created_atstring*
updated_atstring*

DELETE /api/v1/projects/{project_id}/members/{user_id}

Summary: Remove Project Member

Remove a member from a project.

Requires project admin role or organization admin.


Ingestion and connectors

Ingest, ingestion run and connector routes are documented on their own pages: Documents (/api/v1/ingest/*), Ingestion runs (/api/v1/ingestion/*) and Connectors. The earlier /api/v1/ingestion/jobs*, /api/v1/ingestion/batch-jobs, /api/v1/ingestion/stats, /api/v1/workflows/* and /api/v1/ingest/{doc_id}/graph routes have been removed.


GET /api/v1/cache/stats

Summary: Get Cache Stats

Get cache statistics.

Returns hit rate, total requests, and cache status.


POST /api/v1/cache/clear

Summary: Clear Cache

Clear all cache entries.

Requires admin role and confirmation. Use with caution in production!

Request Schema (CacheClearRequest):

PropertyTypeRequiredDescription
confirmboolean*Must be true to confirm cache clear

POST /api/v1/cache/invalidate/{doc_id}

Summary: Invalidate Document Cache

Invalidate cache entries for a specific document.

Call this when a document is updated or deleted.


GET /api/v1/multimodal/images/{image_id}

Summary: Get Image

Get image binary data.

Returns the image file with appropriate content type.


GET /api/v1/dashboard/stats

Summary: Get Dashboard Stats

Get dashboard statistics for the current user's organization.

Returns:

  • Total documents, queries, projects
  • Storage usage
  • Growth percentages (compared to last month)

Response Schema (DashboardStats - Status 200):

PropertyTypeRequiredDescription
total_documentsinteger*
total_queriesinteger*
total_projectsinteger*
storage_used_bytesinteger*
documents_growthnumber*
queries_growthnumber*
projects_growthnumber*

GET /api/v1/dashboard/activity

Summary: Get Recent Activity

Get recent activity for the current user's organization.

Args: limit: Maximum number of activity items to return (default: 10)

Returns: List of recent activity items with descriptions and timestamps


POST /api/v1/ip-whitelist/entries

Summary: Add Ip Entry

Add an IP address or CIDR range to the organization's whitelist.

Only organization admins can add IP entries.

  • ip_address: Single IP (192.168.1.1) or CIDR range (192.168.1.0/24)
  • description: Optional description
  • expires_at: Optional expiration date

Request Schema (IPAddRequest):

PropertyTypeRequiredDescription
ip_addressstring*IP address or CIDR range (e.g., '192.168.1.1' or '192.168.1.0/24')
descriptionanyOptional description for this IP entry
expires_atanyOptional expiration date for this entry

Response Schema (IPWhitelistEntry - Status 201):

PropertyTypeRequiredDescription
idstring*
org_idstring*
ip_addressstring*
ip_range_startany
ip_range_endany
descriptionany
is_activeboolean*
created_atstring*
created_by_user_idany
expires_atany

GET /api/v1/ip-whitelist/entries

Summary: List Ip Entries

List all IP whitelist entries for the organization.

Only organization admins can view IP entries.

  • include_inactive: Include disabled entries
  • include_expired: Include expired entries

Response Schema (IPWhitelistResponse - Status 200):

PropertyTypeRequiredDescription
entriesarray of IPWhitelistEntry*
totalinteger*

GET /api/v1/ip-whitelist/entries/{entry_id}

Summary: Get Ip Entry

Get a specific IP whitelist entry.

Only organization admins can view IP entries.

Response Schema (IPWhitelistEntry - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
ip_addressstring*
ip_range_startany
ip_range_endany
descriptionany
is_activeboolean*
created_atstring*
created_by_user_idany
expires_atany

PATCH /api/v1/ip-whitelist/entries/{entry_id}

Summary: Update Ip Entry

Update an IP whitelist entry.

Only organization admins can update IP entries.

  • description: New description
  • is_active: Enable/disable the entry
  • expires_at: New expiration date

Request Schema (IPUpdateRequest):

PropertyTypeRequiredDescription
descriptionanyNew description for this entry
is_activeanyEnable or disable this entry
expires_atanyNew expiration date

Response Schema (IPWhitelistEntry - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
ip_addressstring*
ip_range_startany
ip_range_endany
descriptionany
is_activeboolean*
created_atstring*
created_by_user_idany
expires_atany

DELETE /api/v1/ip-whitelist/entries/{entry_id}

Summary: Delete Ip Entry

Delete an IP whitelist entry.

Only organization admins can delete IP entries.


GET /api/v1/ip-whitelist/status

Summary: Get Whitelist Status

Get IP whitelist status for the organization.

Returns whether whitelisting is enabled and entry statistics.

Response Schema (IPWhitelistStatusResponse - Status 200):

PropertyTypeRequiredDescription
org_idstring*
enabledboolean*
total_entriesinteger*
active_entriesinteger*
expired_entriesinteger*

PUT /api/v1/ip-whitelist/settings

Summary: Update Whitelist Settings

Enable or disable IP whitelisting for the organization.

WARNING: Enabling IP whitelisting without any entries will block all access! Make sure to add your IP addresses before enabling.

Request Schema (IPWhitelistSettingRequest):

PropertyTypeRequiredDescription
enabledboolean*Whether to enable IP whitelisting for the organization

Response Schema (IPWhitelistStatusResponse - Status 200):

PropertyTypeRequiredDescription
org_idstring*
enabledboolean*
total_entriesinteger*
active_entriesinteger*
expired_entriesinteger*

GET /api/v1/ip-whitelist/check/my-ip

Summary: Check My Ip

Check if your current IP address is whitelisted.

Useful for users to verify their IP before an admin enables whitelisting.

Response Schema (IPCheckResponse - Status 200):

PropertyTypeRequiredDescription
ip_addressstring*
is_whitelistedboolean*
messagestring*

POST /api/v1/ip-whitelist/check

Summary: Check Ip

Check if a specific IP address would be whitelisted.

Only organization admins can check arbitrary IPs. Useful for testing before adding entries.

Request Schema (IPCheckRequest):

PropertyTypeRequiredDescription
ip_addressstring*IP address to check

Response Schema (IPCheckResponse - Status 200):

PropertyTypeRequiredDescription
ip_addressstring*
is_whitelistedboolean*
messagestring*

POST /api/v1/synthesize

Summary: Synthesize

Stateless RAG endpoint: retrieval + fusion + rerank + LLM answer generation.

This endpoint performs single-turn question answering by:

  1. Retrieval: Search using hybrid retrieval (vector + BM25)
  2. Fusion: Merge results using Reciprocal Rank Fusion (RRF)
  3. Reranking: Rerank top candidates with CrossEncoder
  4. Generation: Generate answer with LLM and citations

Use cases:

  • Help centers and FAQ systems
  • Programmatic Q&A endpoints
  • Single-turn question answering
  • Applications that need answers without conversation state

Features:

  • Stateless (no conversation history)
  • Configurable LLM model and parameters
  • Custom prompt templates
  • Citation styles (inline, footnote, none)
  • Token usage tracking and cost estimation
  • Detailed retrieval and answer metadata

Performance:

  • Typical latency: 8-12 seconds
  • Retrieval: ~4-5 seconds
  • Reranking: ~3-4 seconds
  • Answer generation: ~1-2 seconds

Rate limits:

  • 20 requests/minute per API key

Args: request: Synthesis request with query and configuration current_user: Authenticated user (JWT)

Returns: Synthesis response with answer, sources, and metadata

Raises: HTTPException: 400 if invalid request, 401 if unauthorized

Request Schema (SynthesizeRequest):

PropertyTypeRequiredDescription
querystring*Question or query
search_modesanySearch modes to use for retrieval
top_k_per_modeintegerResults per mode before fusion
top_k_for_rerankintegerTop candidates to rerank with CrossEncoder
final_kintegerFinal number of chunks to use for answer generation
filtersanyStructured filter clauses
collection_idanyFilter to specific collection
project_idanyFilter to specific project
fusion_configanyRRF fusion config (e.g., {'k': 60})
llm_modelanyLLM model to use (defaults to settings)
prompt_templateanyCustom prompt template (use {context} and {query} placeholders)
temperaturenumberLLM temperature
max_tokensanyMax tokens for answer
include_citationsbooleanInclude source citations
citation_stylestringCitation style: 'inline', 'footnote', or 'none'

Response Schema (SynthesizeResponse - Status 200):

PropertyTypeRequiredDescription
query_receivedstring*Query as received
answerstring*Generated answer
answer_metadataAnswerMetadata*Answer generation metadata
sourcesarray of AnswerSource*Source documents used
retrieval_metadataRetrievalMetadata*Retrieval process metadata
request_idstring*Unique request ID

GET /api/v1/guardrails/status

Summary: Get Guardrails Status

Get the current status of guardrails service.

Returns configuration and initialization state.

Response Schema (GuardrailsStatusResponse - Status 200):

PropertyTypeRequiredDescription
enabledboolean*
initializedboolean*
config_pathstring*
input_rails_enabledboolean*
output_rails_enabledboolean*
featuresobject*

POST /api/v1/guardrails/check-input

Summary: Check Input

Test input text against input guardrails.

Useful for testing what kinds of inputs would be blocked.

Request Schema (CheckInputRequest):

PropertyTypeRequiredDescription
textstring*
contextany

Response Schema (GuardrailCheckResponse - Status 200):

PropertyTypeRequiredDescription
actionstring*
is_blockedboolean*
is_allowedboolean*
original_textstring*
modified_textany
reasonany
rail_triggeredany
confidencenumber

POST /api/v1/guardrails/check-output

Summary: Check Output

Test output text against output guardrails.

Useful for testing what kinds of outputs would be blocked or modified.

Request Schema (CheckOutputRequest):

PropertyTypeRequiredDescription
responsestring*
user_inputstring*
contextany

Response Schema (GuardrailCheckResponse - Status 200):

PropertyTypeRequiredDescription
actionstring*
is_blockedboolean*
is_allowedboolean*
original_textstring*
modified_textany
reasonany
rail_triggeredany
confidencenumber

POST /api/v1/guardrails/initialize

Summary: Initialize Guardrails

Manually initialize or reinitialize guardrails service.

Admin only - useful for reloading configuration.


GET /api/v1/guardrails/test-patterns

Summary: Get Test Patterns

Get example test patterns for guardrails testing.

Provides sample inputs that should trigger various rails.


POST /api/v1/admin/playground/benchmark

Summary: Run Benchmark

Run benchmark across multiple queries.

Admin only - Benchmark search/chat quality across a query set.

Credits: Charged per query executed:

  • Search mode: 1 credit per query
  • Chat mode: 1-2 credits per query (2 if reformulation triggered)

Features:

  • Batch execution of multiple queries
  • Latency statistics (avg, p50, p95, min, max)
  • Quality metrics (avg top score, low score detection)
  • Gap summary across all queries

Use this to:

  • Evaluate overall retrieval quality
  • Identify systematic gaps in coverage
  • Benchmark performance characteristics
  • Generate quality reports

Request Schema (BenchmarkRequest):

PropertyTypeRequiredDescription
queriesarray of string*List of queries to benchmark
collection_idanyFilter to specific collection
modePlaygroundModeBenchmark mode (search or chat)

Response Schema (BenchmarkResponse - Status 200):

PropertyTypeRequiredDescription
total_queriesinteger*
successfulinteger*
failedinteger*
avg_latency_msnumber*
p50_latency_msnumber*
p95_latency_msnumber*
min_latency_msnumber*
max_latency_msnumber*
avg_top_scoreany
queries_with_low_scoresintegerQueries with top score < 0.5
resultsarray of BenchmarkResult*
gap_summaryobjectSummary of identified gaps
request_idstring*
credits_usedanyTotal credits consumed by benchmark
credits_remaininganyRemaining credit balance

POST /api/v1/projects/{project_id}/from-template

Summary: Set up a project from a marketplace template

Request Schema (ActivateTemplateRequest):

PropertyTypeRequiredDescription
template_idstring*Marketplace template id, e.g. 'T1'

POST /api/v1/projects/{project_id}/verticals

Summary: Activate a vertical for a project

Request Schema (ActivateVerticalRequest):

PropertyTypeRequiredDescription
vertical_keystring*Registered vertical key, e.g. higher_ed or general

DELETE /api/v1/projects/{project_id}/verticals/{vertical_key}

Summary: Deactivate a vertical


GET /api/v1/projects/{project_id}/channels

Summary: List channels


POST /api/v1/projects/{project_id}/channels

Summary: Create Channel

Request Schema (ChannelCreateRequest):

PropertyTypeRequiredDescription
typestring*widget
configobject
target_agent_keyanyPin to one agent; NULL = project entry point

Response Schema (ChannelResponse - Status 201):

PropertyTypeRequiredDescription
idstring*
project_idstring*
typestring*
configobject
target_agent_keyany
enabledboolean*

GET /api/v1/onboarding/status

Summary: First-run onboarding state for the current org

Report whether the org still needs onboarding and where its default project is.

needs_onboarding is true until the wizard is completed (stored on the org). default_project_id / has_agents let the wizard deep-link straight to a working chat (the starter project is auto-provisioned at registration).


POST /api/v1/onboarding/complete

Summary: Mark the current org's onboarding as complete

Set the org's onboarded flag so the first-run wizard stops appearing.


POST /api/v1/widgets

Summary: Create Widget

Create a new widget configuration.

Creates a widget that can be embedded on external websites. Each widget has a unique key used in the embed snippet.

Request Schema (WidgetConfigCreate):

PropertyTypeRequiredDescription
namestring*
descriptionany
primary_colorstring
text_colorstring
positionstring
avatar_urlany
logo_urlany
powered_byboolean
greetingstring
placeholderstring
auto_openboolean
auto_open_delayinteger
featuresobject
allowed_domainsarray of string
rate_limit_messagesinteger
rate_limit_windowinteger
collection_idany
system_promptany
project_idany

Response Schema (WidgetConfigResponse - Status 201):

PropertyTypeRequiredDescription
namestring*
descriptionany
primary_colorstring
text_colorstring
positionstring
avatar_urlany
logo_urlany
powered_byboolean
greetingstring
placeholderstring
auto_openboolean
auto_open_delayinteger
featuresobject
allowed_domainsarray of string
rate_limit_messagesinteger
rate_limit_windowinteger
collection_idany
system_promptany
idstring*
org_idstring*
project_idany
widget_keystring*
is_activeboolean*
total_conversationsinteger*
total_messagesinteger*
created_atstring*
updated_atstring*

GET /api/v1/widgets

Summary: List Widgets

List widget configurations.

Returns all widgets for the current organization.

Response Schema (WidgetConfigListResponse - Status 200):

PropertyTypeRequiredDescription
itemsarray of WidgetConfigResponse*
totalinteger*

GET /api/v1/widgets/{widget_id}

Summary: Get Widget

Get a widget configuration by ID.

Response Schema (WidgetConfigResponse - Status 200):

PropertyTypeRequiredDescription
namestring*
descriptionany
primary_colorstring
text_colorstring
positionstring
avatar_urlany
logo_urlany
powered_byboolean
greetingstring
placeholderstring
auto_openboolean
auto_open_delayinteger
featuresobject
allowed_domainsarray of string
rate_limit_messagesinteger
rate_limit_windowinteger
collection_idany
system_promptany
idstring*
org_idstring*
project_idany
widget_keystring*
is_activeboolean*
total_conversationsinteger*
total_messagesinteger*
created_atstring*
updated_atstring*

PATCH /api/v1/widgets/{widget_id}

Summary: Update Widget

Update a widget configuration.

Request Schema (WidgetConfigUpdate):

PropertyTypeRequiredDescription
nameany
descriptionany
primary_colorany
text_colorany
positionany
avatar_urlany
logo_urlany
powered_byany
greetingany
placeholderany
auto_openany
auto_open_delayany
featuresany
allowed_domainsany
rate_limit_messagesany
rate_limit_windowany
collection_idany
system_promptany
is_activeany

Response Schema (WidgetConfigResponse - Status 200):

PropertyTypeRequiredDescription
namestring*
descriptionany
primary_colorstring
text_colorstring
positionstring
avatar_urlany
logo_urlany
powered_byboolean
greetingstring
placeholderstring
auto_openboolean
auto_open_delayinteger
featuresobject
allowed_domainsarray of string
rate_limit_messagesinteger
rate_limit_windowinteger
collection_idany
system_promptany
idstring*
org_idstring*
project_idany
widget_keystring*
is_activeboolean*
total_conversationsinteger*
total_messagesinteger*
created_atstring*
updated_atstring*

DELETE /api/v1/widgets/{widget_id}

Summary: Delete Widget

Delete a widget configuration.


POST /api/v1/widgets/{widget_id}/regenerate-key

Summary: Regenerate Widget Key

Regenerate the widget's public key.

This will invalidate the current embed code. All existing embeds will need to be updated with the new key.


GET /api/v1/widgets/{widget_id}/embed-code

Summary: Get Embed Code

Get the embed code for a widget.

Response Schema (WidgetEmbedCodeResponse - Status 200):

PropertyTypeRequiredDescription
widget_keystring*
embed_codestring*
cdn_urlstring*

POST /api/v1/widget/init

Summary: Init Widget

Initialize a widget session.

This is called when the widget loads on a page. It validates the widget key, checks domain restrictions, and creates a session.

Returns the widget configuration and a session token for subsequent requests.

Request Schema (WidgetInitRequest):

PropertyTypeRequiredDescription
urlany
referrerany
user_agentany
session_tokenanyPrevious session token from localStorage for cross-visit persistence
new_conversationbooleanStart a new conversation even if resuming an existing session
user_tokenanyOptional JWT token to link widget session to an authenticated user

Response Schema (WidgetInitResponse - Status 200):

PropertyTypeRequiredDescription
successboolean
configWidgetInitConfigResponse*
session_idstring*
conversation_idanyActive conversation ID (if resuming a session with an existing conversation)
is_resumedbooleanWhether this is a resumed session (True) or new session (False)
session_expires_atanyISO timestamp when the session expires (for client-side TTL management)

POST /api/v1/widget/conversations/new

Summary: Start New Conversation

Q3: Start a new conversation on the current session.

This clears the session's conversation link so the next message creates a fresh conversation. The previous conversation remains accessible via its ID for history viewing.


POST /api/v1/widget/messages

Summary: Send Message

Send a message and get a response.

This is the main chat endpoint. It sends the user's message to the RAG system and returns the assistant's response.

Request Schema (WidgetMessageRequest):

PropertyTypeRequiredDescription
contentstring*
conversation_idany
attachmentsany

Response Schema (WidgetSendMessageResponse - Status 200):

PropertyTypeRequiredDescription
successboolean
messageWidgetMessageResponse*
conversation_idstring*

POST /api/v1/widget/messages/stream

Summary: Stream Message

Send a message and stream the response.

Returns a Server-Sent Events stream with:

  • conversation_id: The conversation ID
  • content: Streamed content chunks
  • done: Final message with citations

Request Schema (WidgetMessageRequest):

PropertyTypeRequiredDescription
contentstring*
conversation_idany
attachmentsany

GET /api/v1/widget/conversations/{conversation_id}

Summary: Get Conversation

Get conversation history.

Response Schema (WidgetConversationResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
messagesarray of WidgetMessageResponse*
created_atstring*
updated_atstring*

POST /api/v1/widget/messages/{message_id}/feedback

Summary: Submit Feedback

Submit feedback for a message.

Request Schema (WidgetFeedbackRequest):

PropertyTypeRequiredDescription
feedbackstring*
commentany

POST /api/v1/widget/attachments

Summary: Upload Attachments

Upload file attachments for a message.

Accepts multiple files up to 10MB each. Supported types: images (JPEG, PNG, GIF, WebP), PDF, TXT, DOC, DOCX.

Returns list of attachment metadata with URLs for subsequent message.


GET /health

Summary: Health Check

Check system health.

Returns health status of all components including database, cache, and other services.

Response Schema (HealthCheckResponse - Status 200):

PropertyTypeRequiredDescription
statusstring*
timestampstring
componentsarray of ComponentHealth*
versionstring

GET /health/ready

Summary: Readiness Check

Kubernetes readiness probe endpoint.

Returns 200 if service is ready to accept traffic.


GET /health/live

Summary: Liveness Check

Kubernetes liveness probe endpoint.

Returns 200 if service is alive (doesn't check dependencies).


GET /public/config

Summary: Public Deployment Config

Public deployment configuration the admin web console reads at boot.

No auth — returns only non-sensitive deployment flags so the SPA can gate itself when the admin UI is not licensed (self-hosted) and adapt to the deployment mode. admin_ui_enabled is the license lever (see Settings.admin_ui_enabled).


GET /webhooks/whatsapp

Summary: Verify Subscription

Meta subscription handshake — echo the challenge when the verify token matches.


POST /webhooks/whatsapp

Summary: Inbound

Receive inbound WhatsApp messages (HMAC-verified) and reply via the project agent.


GET /api/v1/artifacts/{artifact_id}

Summary: Get artifact metadata


GET /api/v1/artifacts/{artifact_id}/download

Summary: Download the artifact file


GET /api/v1/artifacts/{artifact_id}/raw

Summary: View the artifact inline (e.g. HTML preview)


GET /api/v1/actions

Summary: List available actions


GET /api/v1/actions/pending/{thread_id}

Summary: Get action(s) awaiting approval for a thread


POST /api/v1/actions/confirm

Summary: Approve or reject pending action(s)

Request Schema (ActionConfirmRequest):

PropertyTypeRequiredDescription
thread_idstring*Conversation thread paused for action approval
approvedboolean*Approve (execute) or reject (cancel) the proposed action(s)
modeanyMode, if the query used a product workflow
org_idanyOrganization id, if the query used a product workflow

GET /api/v1/bot

Summary: Get agent info

Get public info about the organization's entry agent.

Returns the agent display name, greeting, and suggested questions. Used by the widget/frontend to initialize the chat UI. No authentication required.

Response Schema (BotInfoResponse - Status 200):

PropertyTypeRequiredDescription
namestring*
greetingstring*
suggested_questionsarray of string
vertical_typeany
is_activeboolean

GET /api/v1/bot/config

Summary: Get resolved agent config

Get the resolved config for the organization's entry agent.


GET /api/v1/portal/config

Summary: Get Portal Config

One public call the portal makes on load to bootstrap a tenant.

Response Schema (PortalConfigResponse - Status 200):

PropertyTypeRequiredDescription
organizationobject*
brandingobject*
agentobject*
publishable_keyany*

GET /api/v1/credits/balance

Summary: Get Credit Balance

Get current organization's credit balance.

Returns balance details including subscription and purchased credits.

Response Schema (CreditBalanceResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
plan_idany*
plan_nameany*
plan_display_nameany*
current_balanceinteger*
subscription_creditsinteger*
purchased_creditsinteger*
billing_cycle_startany*
billing_cycle_endany*
lifetime_credits_usedinteger*
lifetime_credits_purchasedinteger*
created_atstring*
updated_atstring*

GET /api/v1/credits/check/{action_type}

Summary: Check Credits

Check if organization has sufficient credits for an action.

Does not deduct credits, only checks availability.

Response Schema (CreditCheckResponse - Status 200):

PropertyTypeRequiredDescription
has_sufficientboolean*
requiredinteger*
availableinteger*
actionstring*

GET /api/v1/credits/plans

Summary: List Plans

List available subscription plans.

Public endpoint - no authentication required.

Response Schema (CreditPlanListResponse - Status 200):

PropertyTypeRequiredDescription
plansarray of CreditPlanResponse*

POST /api/v1/credits/plan

Summary: Change Plan

Change organization's subscription plan (admin only).

Note: Credits are adjusted on next billing cycle renewal.

Request Schema (ChangePlanRequest):

PropertyTypeRequiredDescription
plan_namestring*Name of the new plan

Response Schema (ChangePlanResponse - Status 200):

PropertyTypeRequiredDescription
successboolean*
previous_planany*
new_planstring*
messagestring*
balanceCreditBalanceResponse*

GET /api/v1/credits/pricing

Summary: List Pricing

List credit pricing for all action types.

Public endpoint - no authentication required.

Response Schema (PricingListResponse - Status 200):

PropertyTypeRequiredDescription
pricingarray of CreditPricingResponse*

GET /api/v1/credits/transactions

Summary: List Transactions

Get organization's credit transaction history.

Supports filtering by transaction type, action type, and date range.

Response Schema (TransactionListResponse - Status 200):

PropertyTypeRequiredDescription
transactionsarray of CreditTransactionResponse*
totalinteger*
pageinteger*
page_sizeinteger*

GET /api/v1/credits/usage

Summary: Get Usage Summary

Get credit usage summary for organization.

Returns breakdown by action type for the specified period.

Response Schema (UsageSummaryResponse - Status 200):

PropertyTypeRequiredDescription
period_startstring*
period_endstring*
total_usedinteger*
by_actionobject*
current_balanceinteger*
subscription_creditsinteger*
purchased_creditsinteger*

POST /api/v1/credits/purchase

Summary: Create Purchase

Create a credit purchase order (admin only).

Returns purchase record with pending status. Call /credits/purchase/{id}/complete after payment succeeds.

Request Schema (CreditPurchaseRequest):

PropertyTypeRequiredDescription
credits_amountinteger*Number of credits to purchase (min 100)
payment_provideranyPayment provider (stripe, paystack)

Response Schema (CreditPurchaseResponse - Status 201):

PropertyTypeRequiredDescription
idstring*
org_idstring*
user_idany*
credits_amountinteger*
price_centsinteger*
currencystring*
payment_providerany*
payment_idany*
payment_methodany*
statusstring*
completed_atany*
refunded_atany*
created_atstring*

POST /api/v1/credits/purchase/{purchase_id}/complete

Summary: Complete Purchase

Complete a pending purchase and add credits (admin only).

Called after payment provider confirms payment.

Request Schema (CompletePurchaseRequest):

PropertyTypeRequiredDescription
payment_idstring*External payment reference ID
payment_methodanyPayment method used

Response Schema (CreditPurchaseResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
user_idany*
credits_amountinteger*
price_centsinteger*
currencystring*
payment_providerany*
payment_idany*
payment_methodany*
statusstring*
completed_atany*
refunded_atany*
created_atstring*

GET /api/v1/credits/purchases

Summary: List Purchases

List organization's credit purchases (admin only).

Response Schema (PurchaseListResponse - Status 200):

PropertyTypeRequiredDescription
purchasesarray of CreditPurchaseResponse*
totalinteger*
pageinteger*
page_sizeinteger*

GET /api/v1/credits/packages

Summary: List Credit Packages

List available credit packages for purchase.

Returns pricing for all available credit amounts. Public endpoint - no authentication required.


POST /api/v1/credits/checkout

Summary: Create Checkout

Create a Stripe checkout session for credit purchase (admin only).

Returns a URL to redirect the user to Stripe's hosted checkout page. After payment, Stripe will redirect to success_url with session_id parameter.


GET /api/v1/credits/checkout/{session_id}

Summary: Get Checkout Status

Get the status of a checkout session.

Use this after redirect from Stripe to verify payment status.


POST /api/v1/credits/admin/adjust

Summary: Admin Adjust Credits

Manually adjust credits for an organization (admin only).

Use positive amount to add credits, negative to remove.

Request Schema (AdminCreditAdjustment):

PropertyTypeRequiredDescription
org_idstring*Organization ID
amountinteger*Credits to add (positive) or remove (negative)
reasonstring*Reason for adjustment

Response Schema (AdminCreditAdjustmentResponse - Status 200):

PropertyTypeRequiredDescription
successboolean*
transaction_idstring*
org_idstring*
amountinteger*
new_balanceinteger*
reasonstring*

POST /api/v1/credits/admin/renew-all

Summary: Trigger Subscription Renewals

Trigger subscription renewal for all expired billing cycles (admin only).

This endpoint runs the renewal flow synchronously and returns results. For production, use the scheduled Prefect flow instead.


POST /api/v1/credits/admin/renew/{org_id}

Summary: Renew Org Subscription

Renew subscription for a specific organization (admin only).

Useful for manual renewals or customer support actions.


GET /api/v1/credits/admin/low-balance

Summary: Check Low Balances

Check for organizations with low credit balances (admin only).

Returns list of orgs whose balance is below the threshold percentage of their monthly credit allowance.


GET /api/v1/credits/admin/expiring

Summary: List Expiring Subscriptions

List subscriptions expiring soon (admin only).

Shows organizations whose billing cycle ends within the specified days.


POST /api/v1/credits/admin/alerts/low-balance

Summary: Trigger Low Balance Alerts

Trigger low balance alert check and notifications (admin only).

Sends email notifications to org admins whose balance is below threshold.


POST /api/v1/credits/admin/alerts/exhausted

Summary: Trigger Exhausted Alerts

Trigger credit exhaustion alerts (admin only).

Sends alerts to organizations with zero credits.


POST /api/v1/credits/admin/alerts/test

Summary: Send Test Alert

Send a test alert notification (admin only).

Useful for verifying email/webhook configuration.


POST /webhooks/stripe

Summary: Stripe Webhook

Handle Stripe webhook events.

This endpoint receives events from Stripe for:

  • checkout.session.completed (credit purchase completed)
  • payment_intent.succeeded (payment confirmed)
  • payment_intent.payment_failed (payment failed)
  • charge.refunded (refund processed)
  • customer.subscription.* (subscription events)
  • invoice.paid (subscription renewal)

Configure webhook URL in Stripe Dashboard: https://dashboard.stripe.com/webhooks

Required events to enable:

  • checkout.session.completed
  • payment_intent.succeeded
  • payment_intent.payment_failed
  • charge.refunded
  • customer.subscription.created
  • customer.subscription.updated
  • customer.subscription.deleted
  • invoice.paid
  • invoice.payment_failed

POST /webhooks/paystack

Summary: Paystack Webhook

Handle Paystack webhook events (for African markets).

Similar to Stripe but for Paystack payment provider. Enable with ENABLE_PAYSTACK=true in configuration.


GET /api/v1/cms/schema/field-types

Summary: List Field Types

List all available field types.


GET /api/v1/cms/schema/field-types/{slug}

Summary: Get Field Type

Get a field type by slug.

Response Schema (FieldTypeResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
slugstring*
namestring*
descriptionany
categorystring*
input_schemaobject*
output_schemaobject*
default_settingsobject
editor_componentstring*
display_componentstring*
list_componentany
is_localizableboolean
is_searchableboolean
is_sortableboolean
is_filterableboolean
is_systemboolean
is_enabledboolean

GET /api/v1/cms/schema/validation-rules

Summary: List Validation Rules

List validation rules, optionally filtered by field type.


GET /api/v1/cms/schema/content-types

Summary: List Content Types

List content types for the organization.

Omit project_id for the org-level view (every type). Pass a project id for that project's Content tab (project-private types ∪ org-shared types).


POST /api/v1/cms/schema/content-types

Summary: Create Content Type

Create a new content type (org-shared or project-private).

Request Schema (ContentTypeCreate):

PropertyTypeRequiredDescription
slugstring*URL-safe identifier
namestring*Singular display name
name_pluralstring*Plural display name
project_idanyScope: project this type is private to. Omit/null = org-shared (all projects). Set at creation only.
descriptionany
iconany
display_fieldstring*Field api_id to use as entry title
preview_fieldsarray of string
is_singletonboolean
enable_versioningboolean
enable_localizationboolean
enable_slugboolean
enable_schedulingboolean
workflow_idany
api_enabledboolean
api_cache_ttlinteger
rag_enabledboolean
rag_templateany
sort_orderinteger
fieldsarray of FieldDefinitionCreate

Response Schema (ContentTypeResponse - Status 201):

PropertyTypeRequiredDescription
idstring*
org_idstring*
project_idany
slugstring*
namestring*
name_pluralstring*
descriptionany
iconany
display_fieldstring*
preview_fieldsarray of string
is_singletonboolean
enable_versioningboolean
enable_localizationboolean
enable_slugboolean
enable_schedulingboolean
workflow_idany
api_enabledboolean
api_cache_ttlinteger
rag_enabledboolean
rag_templateany
is_systemboolean
is_enabledboolean
sort_orderinteger
fieldsarray of FieldDefinitionResponse
created_atstring*
updated_atstring*

GET /api/v1/cms/schema/content-types/{slug}

Summary: Get Content Type

Get a content type by slug.

Response Schema (ContentTypeResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
project_idany
slugstring*
namestring*
name_pluralstring*
descriptionany
iconany
display_fieldstring*
preview_fieldsarray of string
is_singletonboolean
enable_versioningboolean
enable_localizationboolean
enable_slugboolean
enable_schedulingboolean
workflow_idany
api_enabledboolean
api_cache_ttlinteger
rag_enabledboolean
rag_templateany
is_systemboolean
is_enabledboolean
sort_orderinteger
fieldsarray of FieldDefinitionResponse
created_atstring*
updated_atstring*

PATCH /api/v1/cms/schema/content-types/{slug}

Summary: Update Content Type

Update a content type.

Request Schema (ContentTypeUpdate):

PropertyTypeRequiredDescription
nameany
name_pluralany
descriptionany
iconany
display_fieldany
preview_fieldsany
is_singletonany
enable_versioningany
enable_localizationany
enable_slugany
enable_schedulingany
workflow_idany
api_enabledany
api_cache_ttlany
rag_enabledany
rag_templateany
sort_orderany
is_enabledany

Response Schema (ContentTypeResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
project_idany
slugstring*
namestring*
name_pluralstring*
descriptionany
iconany
display_fieldstring*
preview_fieldsarray of string
is_singletonboolean
enable_versioningboolean
enable_localizationboolean
enable_slugboolean
enable_schedulingboolean
workflow_idany
api_enabledboolean
api_cache_ttlinteger
rag_enabledboolean
rag_templateany
is_systemboolean
is_enabledboolean
sort_orderinteger
fieldsarray of FieldDefinitionResponse
created_atstring*
updated_atstring*

DELETE /api/v1/cms/schema/content-types/{slug}

Summary: Delete Content Type

Delete a content type.


POST /api/v1/cms/schema/content-types/{slug}/fields

Summary: Add Field

Add a field to a content type.

Request Schema (FieldDefinitionCreate):

PropertyTypeRequiredDescription
api_idstring*API field name
namestring*Human-readable label
descriptionany
placeholderany
field_type_slugstring*Field type slug
settingsobject
validation_rulesarray of objectArray of {rule_slug, config}
is_requiredboolean
is_uniqueboolean
is_localizableboolean
ui_widthstringGrid width: full, half, third, quarter
ui_groupany
ui_orderinteger
ui_hiddenboolean
ui_readonlyboolean
conditionsany
default_valueany

Response Schema (ContentTypeResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
project_idany
slugstring*
namestring*
name_pluralstring*
descriptionany
iconany
display_fieldstring*
preview_fieldsarray of string
is_singletonboolean
enable_versioningboolean
enable_localizationboolean
enable_slugboolean
enable_schedulingboolean
workflow_idany
api_enabledboolean
api_cache_ttlinteger
rag_enabledboolean
rag_templateany
is_systemboolean
is_enabledboolean
sort_orderinteger
fieldsarray of FieldDefinitionResponse
created_atstring*
updated_atstring*

PATCH /api/v1/cms/schema/content-types/{slug}/fields/{api_id}

Summary: Update Field

Update a field definition.

Request Schema (FieldDefinitionUpdate):

PropertyTypeRequiredDescription
nameany
descriptionany
placeholderany
settingsany
validation_rulesany
is_requiredany
is_uniqueany
is_localizableany
ui_widthany
ui_groupany
ui_orderany
ui_hiddenany
ui_readonlyany
conditionsany
default_valueany

Response Schema (ContentTypeResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
project_idany
slugstring*
namestring*
name_pluralstring*
descriptionany
iconany
display_fieldstring*
preview_fieldsarray of string
is_singletonboolean
enable_versioningboolean
enable_localizationboolean
enable_slugboolean
enable_schedulingboolean
workflow_idany
api_enabledboolean
api_cache_ttlinteger
rag_enabledboolean
rag_templateany
is_systemboolean
is_enabledboolean
sort_orderinteger
fieldsarray of FieldDefinitionResponse
created_atstring*
updated_atstring*

DELETE /api/v1/cms/schema/content-types/{slug}/fields/{api_id}

Summary: Delete Field

Delete a field from a content type.

Response Schema (ContentTypeResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
project_idany
slugstring*
namestring*
name_pluralstring*
descriptionany
iconany
display_fieldstring*
preview_fieldsarray of string
is_singletonboolean
enable_versioningboolean
enable_localizationboolean
enable_slugboolean
enable_schedulingboolean
workflow_idany
api_enabledboolean
api_cache_ttlinteger
rag_enabledboolean
rag_templateany
is_systemboolean
is_enabledboolean
sort_orderinteger
fieldsarray of FieldDefinitionResponse
created_atstring*
updated_atstring*

POST /api/v1/cms/schema/import

Summary: Import Schema

Import schema from YAML/JSON file.


GET /api/v1/cms/schema/export

Summary: Export Schema

Export schema as JSON.


GET /api/v1/cms/schema/workflows

Summary: List Workflows

List all workflows for the organization.


POST /api/v1/cms/schema/workflows

Summary: Create Workflow

Create a new workflow.

Request Schema (WorkflowCreate):

PropertyTypeRequiredDescription
slugstring*
namestring*
descriptionany
initial_statestring*State slug for new entries
statesarray of WorkflowStateCreate
transitionsarray of WorkflowTransitionCreate

Response Schema (apps__cms__schemas__workflow__WorkflowResponse - Status 201):

PropertyTypeRequiredDescription
idstring*
org_idstring*
slugstring*
namestring*
descriptionany
initial_statestring*
is_systemboolean
is_enabledboolean
statesarray of WorkflowStateResponse
transitionsarray of WorkflowTransitionResponse
created_atstring*
updated_atstring*

GET /api/v1/cms/schema/workflows/{slug}

Summary: Get Workflow

Get a workflow by slug.

Response Schema (apps__cms__schemas__workflow__WorkflowResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
slugstring*
namestring*
descriptionany
initial_statestring*
is_systemboolean
is_enabledboolean
statesarray of WorkflowStateResponse
transitionsarray of WorkflowTransitionResponse
created_atstring*
updated_atstring*

PATCH /api/v1/cms/schema/workflows/{slug}

Summary: Update Workflow

Update a workflow.

Request Schema (WorkflowUpdate):

PropertyTypeRequiredDescription
nameany
descriptionany
initial_stateany
is_enabledany

Response Schema (apps__cms__schemas__workflow__WorkflowResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
slugstring*
namestring*
descriptionany
initial_statestring*
is_systemboolean
is_enabledboolean
statesarray of WorkflowStateResponse
transitionsarray of WorkflowTransitionResponse
created_atstring*
updated_atstring*

DELETE /api/v1/cms/schema/workflows/{slug}

Summary: Delete Workflow

Delete a workflow.


POST /api/v1/cms/schema/workflows/create-default

Summary: Create Default Workflow

Create the default publishing workflow for the organization.

This creates a standard workflow with states: Draft → Review → Published → Archived and appropriate transitions between them.


GET /api/v1/cms/content/{type_slug}

Summary: List Entries

List content entries for a content type.

Response Schema (ContentListResponse - Status 200):

PropertyTypeRequiredDescription
itemsarray of ContentEntryResponse*
totalinteger*
limitinteger*
offsetinteger*
pageinteger
pagesinteger

POST /api/v1/cms/content/{type_slug}

Summary: Create Entry

Create a new content entry.

Request Schema (ContentEntryCreate):

PropertyTypeRequiredDescription
dataobject*Field values as JSON object
localized_dataobjectPer-locale field overrides: {locale: {field: value}}

Response Schema (ContentEntryResponse - Status 201):

PropertyTypeRequiredDescription
idstring*
content_type_idstring*
content_type_slugany
org_idstring*
dataobject
localized_dataobject
statusstring
workflow_stateany
versioninteger
slugany
created_bystring*
updated_byany
published_atany
created_atstring*
updated_atstring*

GET /api/v1/cms/content/{type_slug}/{entry_id}

Summary: Get Entry

Get a content entry by ID.

Response Schema (ContentEntryResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
content_type_idstring*
content_type_slugany
org_idstring*
dataobject
localized_dataobject
statusstring
workflow_stateany
versioninteger
slugany
created_bystring*
updated_byany
published_atany
created_atstring*
updated_atstring*

PATCH /api/v1/cms/content/{type_slug}/{entry_id}

Summary: Update Entry

Update a content entry.

Request Schema (ContentEntryUpdate):

PropertyTypeRequiredDescription
dataobject*Field values to update
localized_dataany
change_summaryanyDescription of changes

Response Schema (ContentEntryResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
content_type_idstring*
content_type_slugany
org_idstring*
dataobject
localized_dataobject
statusstring
workflow_stateany
versioninteger
slugany
created_bystring*
updated_byany
published_atany
created_atstring*
updated_atstring*

DELETE /api/v1/cms/content/{type_slug}/{entry_id}

Summary: Delete Entry

Delete a content entry.


POST /api/v1/cms/content/{type_slug}/{entry_id}/transition

Summary: Transition Entry

Transition entry to a new workflow state.

Request Schema (TransitionRequest):

PropertyTypeRequiredDescription
to_statestring*Target state slug
commentanyTransition comment/reason

Response Schema (ContentEntryResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
content_type_idstring*
content_type_slugany
org_idstring*
dataobject
localized_dataobject
statusstring
workflow_stateany
versioninteger
slugany
created_bystring*
updated_byany
published_atany
created_atstring*
updated_atstring*

GET /api/v1/cms/content/{type_slug}/{entry_id}/available-transitions

Summary: Get Available Transitions

Get available workflow transitions for an entry.


GET /api/v1/cms/content/{type_slug}/{entry_id}/versions

Summary: Get Versions

Get version history for an entry.


POST /api/v1/cms/content/{type_slug}/{entry_id}/versions/{version}/restore

Summary: Restore Version

Restore an entry to a previous version.

Response Schema (ContentEntryResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
content_type_idstring*
content_type_slugany
org_idstring*
dataobject
localized_dataobject
statusstring
workflow_stateany
versioninteger
slugany
created_bystring*
updated_byany
published_atany
created_atstring*
updated_atstring*

POST /api/v1/cms/content/{type_slug}/bulk-delete

Summary: Bulk Delete

Bulk delete multiple entries.


POST /api/v1/cms/content/{type_slug}/bulk-transition

Summary: Bulk Transition

Bulk transition multiple entries to a new state.


GET /api/v1/cms/delivery/{type_slug}

Summary: List Published

List published content entries.

Only returns entries in a published workflow state. Supports pagination and sorting.


GET /api/v1/cms/delivery/{type_slug}/by-slug/{slug}

Summary: Get By Slug

Get a published entry by its slug.

Returns 404 if entry doesn't exist or isn't published.


GET /api/v1/cms/delivery/{type_slug}/_schema

Summary: Get Type Schema

Get the schema for a content type.

Useful for client SDKs to understand the structure.


GET /api/v1/cms/delivery/{type_slug}/singleton

Summary: Get Singleton

Get singleton content (for types with is_singleton=true).

Returns the single published entry for singleton types like settings pages.


GET /api/v1/cms/delivery/_cache/stats

Summary: Get Cache Stats

Get CMS delivery API cache statistics.

Returns hit rate, miss count, and other cache metrics. Useful for monitoring cache effectiveness.


POST /api/v1/cms/delivery/_cache/clear

Summary: Clear Cache

Clear all CMS delivery API caches for the organization.

Use with caution - this will cause a temporary increase in database load until caches are repopulated.


GET /api/v1/cms/delivery/{type_slug}/{entry_id}

Summary: Get By Id

Get a published entry by its ID.

Returns 404 if entry doesn't exist or isn't published.


GET /api/v1/cms/media/folders

Summary: List Folders

List media folders.


POST /api/v1/cms/media/folders

Summary: Create Folder

Create a new media folder.

Request Schema (MediaFolderCreate):

PropertyTypeRequiredDescription
namestring*
parent_idany

Response Schema (MediaFolderResponse - Status 201):

PropertyTypeRequiredDescription
idstring*
org_idstring*
parent_idany
namestring*
pathstring*
created_atstring*
updated_atstring*

DELETE /api/v1/cms/media/folders/{folder_id}

Summary: Delete Folder

Delete a media folder.


GET /api/v1/cms/media

Summary: List Media

List media files.

Response Schema (MediaListResponse - Status 200):

PropertyTypeRequiredDescription
itemsarray of MediaResponse*
totalinteger*
limitinteger*
offsetinteger*
foldersarray of MediaFolderResponse

GET /api/v1/cms/media/{media_id}

Summary: Get Media

Get a media file by ID.

Response Schema (MediaResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
folder_idany
filenamestring*
original_filenamestring*
mime_typestring*
file_sizeinteger*
storage_providerstring*
storage_keystring*
storage_urlany
urlstring*
widthany
heightany
variantsobject
alt_textany
captionany
titleany
metadataobject
uploaded_bystring*
created_atstring*
updated_atstring*

PATCH /api/v1/cms/media/{media_id}

Summary: Update Media

Update media metadata.

Request Schema (MediaUpdateRequest):

PropertyTypeRequiredDescription
alt_textany
captionany
titleany
folder_idany

Response Schema (MediaResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
folder_idany
filenamestring*
original_filenamestring*
mime_typestring*
file_sizeinteger*
storage_providerstring*
storage_keystring*
storage_urlany
urlstring*
widthany
heightany
variantsobject
alt_textany
captionany
titleany
metadataobject
uploaded_bystring*
created_atstring*
updated_atstring*

DELETE /api/v1/cms/media/{media_id}

Summary: Delete Media

Delete a media file.


POST /api/v1/cms/media/upload

Summary: Upload Media

Upload a new media file.

Response Schema (MediaResponse - Status 201):

PropertyTypeRequiredDescription
idstring*
org_idstring*
folder_idany
filenamestring*
original_filenamestring*
mime_typestring*
file_sizeinteger*
storage_providerstring*
storage_keystring*
storage_urlany
urlstring*
widthany
heightany
variantsobject
alt_textany
captionany
titleany
metadataobject
uploaded_bystring*
created_atstring*
updated_atstring*

POST /api/v1/cms/media/{media_id}/move

Summary: Move Media

Move media to a different folder.

Response Schema (MediaResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
folder_idany
filenamestring*
original_filenamestring*
mime_typestring*
file_sizeinteger*
storage_providerstring*
storage_keystring*
storage_urlany
urlstring*
widthany
heightany
variantsobject
alt_textany
captionany
titleany
metadataobject
uploaded_bystring*
created_atstring*
updated_atstring*

POST /api/v1/cms/media/{media_id}/generate-variants

Summary: Generate Variants

Generate image variants (thumbnails, responsive sizes).

Response Schema (MediaResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
folder_idany
filenamestring*
original_filenamestring*
mime_typestring*
file_sizeinteger*
storage_providerstring*
storage_keystring*
storage_urlany
urlstring*
widthany
heightany
variantsobject
alt_textany
captionany
titleany
metadataobject
uploaded_bystring*
created_atstring*
updated_atstring*

POST /api/v1/cms/media/bulk-delete

Summary: Bulk Delete

Bulk delete multiple media files.


POST /api/v1/cms/media/bulk-move

Summary: Bulk Move

Bulk move multiple media files to a folder.


GET /api/v1/cms/webhooks

Summary: List Webhooks

List all webhooks for the organization.


POST /api/v1/cms/webhooks

Summary: Create Webhook

Create a new webhook.

Request Schema (WebhookCreate):

PropertyTypeRequiredDescription
namestring*
descriptionany
urlstring*Target URL for webhook delivery
secretanySecret for HMAC signature
eventsarray of string*Event types to trigger on
content_typesarray of stringContent type slugs to filter
is_enabledboolean
retry_countinteger
timeout_secondsinteger
headersobject

Response Schema (WebhookResponse - Status 201):

PropertyTypeRequiredDescription
idstring*
org_idstring*
namestring*
descriptionany
urlstring*
eventsarray of string
content_typesarray of string
is_enabledboolean
retry_countinteger
timeout_secondsinteger
headersobject
created_atstring*
updated_atstring*

GET /api/v1/cms/webhooks/{webhook_id}

Summary: Get Webhook

Get a webhook by ID.

Response Schema (WebhookResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
namestring*
descriptionany
urlstring*
eventsarray of string
content_typesarray of string
is_enabledboolean
retry_countinteger
timeout_secondsinteger
headersobject
created_atstring*
updated_atstring*

PATCH /api/v1/cms/webhooks/{webhook_id}

Summary: Update Webhook

Update a webhook.

Request Schema (WebhookUpdate):

PropertyTypeRequiredDescription
nameany
descriptionany
urlany
secretany
eventsany
content_typesany
is_enabledany
retry_countany
timeout_secondsany
headersany

Response Schema (WebhookResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
org_idstring*
namestring*
descriptionany
urlstring*
eventsarray of string
content_typesarray of string
is_enabledboolean
retry_countinteger
timeout_secondsinteger
headersobject
created_atstring*
updated_atstring*

DELETE /api/v1/cms/webhooks/{webhook_id}

Summary: Delete Webhook

Delete a webhook.


POST /api/v1/cms/webhooks/{webhook_id}/test

Summary: Test Webhook

Send a test event to a webhook.

Response Schema (WebhookTestResponse - Status 200):

PropertyTypeRequiredDescription
successboolean*
status_codeany
response_time_msany
error_messageany
delivery_idstring*

GET /api/v1/cms/webhooks/{webhook_id}/deliveries

Summary: Get Deliveries

Get delivery history for a webhook.


GET /api/v1/cms/webhooks/{webhook_id}/deliveries/{delivery_id}

Summary: Get Delivery

Get a specific delivery record.

Response Schema (WebhookDeliveryResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
webhook_idstring*
event_typestring*
payloadobject*
status_codeany
response_bodyany
response_time_msany
successany
error_messageany
attempt_countinteger
created_atstring*

POST /api/v1/cms/webhooks/{webhook_id}/deliveries/{delivery_id}/retry

Summary: Retry Delivery

Manually retry a failed delivery.

Response Schema (WebhookDeliveryResponse - Status 200):

PropertyTypeRequiredDescription
idstring*
webhook_idstring*
event_typestring*
payloadobject*
status_codeany
response_bodyany
response_time_msany
successany
error_messageany
attempt_countinteger
created_atstring*

GET /api/v1/cms/webhooks/events/supported

Summary: Get Supported Events

Get list of supported webhook events.


GET /

Summary: Root

Root endpoint with API information.


Additional current operations

The following operations are also present in the current application schema. They are listed here because they are easy to miss when browsing the grouped reference pages; /openapi.json remains authoritative for their schemas.

DELETE /api/v1/phone-numbers/{phone_number_id}

Delete a configured phone number.

GET /api/v1/cms/content/{type_slug}/export

Export CMS content for a content type.

GET /api/v1/projects/{project_id}/phone-numbers

List phone numbers assigned to a project.

GET /api/v1/telephony/numbers/search

Search available telephony numbers.

POST /api/v1/billing/webhooks/flutterwave

Receive a Flutterwave billing webhook in SaaS mode.

POST /api/v1/cms/content/{type_slug}/import

Import CMS content for a content type.

POST /api/v1/cms/content/{type_slug}/publish

Publish CMS content for a content type.

POST /api/v1/credits/flutterwave/checkout

Create a Flutterwave credit checkout session.

POST /api/v1/projects/{project_id}/phone-numbers

Assign or provision a phone number for a project.

POST /api/v1/voice/session

Create a voice session.

POST /api/v1/voice/session/{session_id}/end

End a voice session.

POST /api/v1/voice/tool

Handle a voice tool invocation.

POST /webhooks/email/agentmail

Receive an AgentMail webhook.

POST /webhooks/flutterwave

Receive a root-level Flutterwave webhook.

POST /webhooks/telephony/telnyx

Receive a Telnyx telephony webhook.

POST /webhooks/telephony/vonage/answer

Return a Vonage answer webhook response.

POST /webhooks/telephony/vonage/event

Receive a Vonage telephony event webhook.

On this page

Projects APIPOST /api/v1/api/keysGET /api/v1/api/keysPOST /api/v1/api/keys/tokensDELETE /api/v1/api/keys/{key_id}MCP serversGET /api/v1/branding/themesPOST /api/v1/conversationsGET /api/v1/conversationsGET /api/v1/conversations/{conversation_id}PATCH /api/v1/conversations/{conversation_id}POST /api/v1/conversations/{conversation_id}/closePOST /api/v1/conversations/{conversation_id}/messagesGET /api/v1/conversations/{conversation_id}/messagesPOST /api/v1/conversations/messages/{message_id}/feedbackPOST /api/v1/conversations/messages/{message_id}/regeneratePATCH /api/v1/conversations/messages/{message_id}/editGET /api/v1/conversations/sitegpt/{conversation_id}/detailsGET /api/v1/conversations/inboxGET /api/v1/conversations/inbox/{conversation_id}POST /api/v1/projects/GET /api/v1/projects/GET /api/v1/projects/{project_id}PATCH /api/v1/projects/{project_id}DELETE /api/v1/projects/{project_id}GET /api/v1/projects/{project_id}/membersPOST /api/v1/projects/{project_id}/membersPATCH /api/v1/projects/{project_id}/members/{user_id}DELETE /api/v1/projects/{project_id}/members/{user_id}Ingestion and connectorsGET /api/v1/cache/statsPOST /api/v1/cache/clearPOST /api/v1/cache/invalidate/{doc_id}GET /api/v1/multimodal/images/{image_id}GET /api/v1/dashboard/statsGET /api/v1/dashboard/activityPOST /api/v1/ip-whitelist/entriesGET /api/v1/ip-whitelist/entriesGET /api/v1/ip-whitelist/entries/{entry_id}PATCH /api/v1/ip-whitelist/entries/{entry_id}DELETE /api/v1/ip-whitelist/entries/{entry_id}GET /api/v1/ip-whitelist/statusPUT /api/v1/ip-whitelist/settingsGET /api/v1/ip-whitelist/check/my-ipPOST /api/v1/ip-whitelist/checkPOST /api/v1/synthesizeGET /api/v1/guardrails/statusPOST /api/v1/guardrails/check-inputPOST /api/v1/guardrails/check-outputPOST /api/v1/guardrails/initializeGET /api/v1/guardrails/test-patternsPOST /api/v1/admin/playground/benchmarkPOST /api/v1/projects/{project_id}/from-templatePOST /api/v1/projects/{project_id}/verticalsDELETE /api/v1/projects/{project_id}/verticals/{vertical_key}GET /api/v1/projects/{project_id}/channelsPOST /api/v1/projects/{project_id}/channelsGET /api/v1/onboarding/statusPOST /api/v1/onboarding/completePOST /api/v1/widgetsGET /api/v1/widgetsGET /api/v1/widgets/{widget_id}PATCH /api/v1/widgets/{widget_id}DELETE /api/v1/widgets/{widget_id}POST /api/v1/widgets/{widget_id}/regenerate-keyGET /api/v1/widgets/{widget_id}/embed-codePOST /api/v1/widget/initPOST /api/v1/widget/conversations/newPOST /api/v1/widget/messagesPOST /api/v1/widget/messages/streamGET /api/v1/widget/conversations/{conversation_id}POST /api/v1/widget/messages/{message_id}/feedbackPOST /api/v1/widget/attachmentsGET /healthGET /health/readyGET /health/liveGET /public/configGET /webhooks/whatsappPOST /webhooks/whatsappGET /api/v1/artifacts/{artifact_id}GET /api/v1/artifacts/{artifact_id}/downloadGET /api/v1/artifacts/{artifact_id}/rawGET /api/v1/actionsGET /api/v1/actions/pending/{thread_id}POST /api/v1/actions/confirmGET /api/v1/botGET /api/v1/bot/configGET /api/v1/portal/configGET /api/v1/credits/balanceGET /api/v1/credits/check/{action_type}GET /api/v1/credits/plansPOST /api/v1/credits/planGET /api/v1/credits/pricingGET /api/v1/credits/transactionsGET /api/v1/credits/usagePOST /api/v1/credits/purchasePOST /api/v1/credits/purchase/{purchase_id}/completeGET /api/v1/credits/purchasesGET /api/v1/credits/packagesPOST /api/v1/credits/checkoutGET /api/v1/credits/checkout/{session_id}POST /api/v1/credits/admin/adjustPOST /api/v1/credits/admin/renew-allPOST /api/v1/credits/admin/renew/{org_id}GET /api/v1/credits/admin/low-balanceGET /api/v1/credits/admin/expiringPOST /api/v1/credits/admin/alerts/low-balancePOST /api/v1/credits/admin/alerts/exhaustedPOST /api/v1/credits/admin/alerts/testPOST /webhooks/stripePOST /webhooks/paystackGET /api/v1/cms/schema/field-typesGET /api/v1/cms/schema/field-types/{slug}GET /api/v1/cms/schema/validation-rulesGET /api/v1/cms/schema/content-typesPOST /api/v1/cms/schema/content-typesGET /api/v1/cms/schema/content-types/{slug}PATCH /api/v1/cms/schema/content-types/{slug}DELETE /api/v1/cms/schema/content-types/{slug}POST /api/v1/cms/schema/content-types/{slug}/fieldsPATCH /api/v1/cms/schema/content-types/{slug}/fields/{api_id}DELETE /api/v1/cms/schema/content-types/{slug}/fields/{api_id}POST /api/v1/cms/schema/importGET /api/v1/cms/schema/exportGET /api/v1/cms/schema/workflowsPOST /api/v1/cms/schema/workflowsGET /api/v1/cms/schema/workflows/{slug}PATCH /api/v1/cms/schema/workflows/{slug}DELETE /api/v1/cms/schema/workflows/{slug}POST /api/v1/cms/schema/workflows/create-defaultGET /api/v1/cms/content/{type_slug}POST /api/v1/cms/content/{type_slug}GET /api/v1/cms/content/{type_slug}/{entry_id}PATCH /api/v1/cms/content/{type_slug}/{entry_id}DELETE /api/v1/cms/content/{type_slug}/{entry_id}POST /api/v1/cms/content/{type_slug}/{entry_id}/transitionGET /api/v1/cms/content/{type_slug}/{entry_id}/available-transitionsGET /api/v1/cms/content/{type_slug}/{entry_id}/versionsPOST /api/v1/cms/content/{type_slug}/{entry_id}/versions/{version}/restorePOST /api/v1/cms/content/{type_slug}/bulk-deletePOST /api/v1/cms/content/{type_slug}/bulk-transitionGET /api/v1/cms/delivery/{type_slug}GET /api/v1/cms/delivery/{type_slug}/by-slug/{slug}GET /api/v1/cms/delivery/{type_slug}/_schemaGET /api/v1/cms/delivery/{type_slug}/singletonGET /api/v1/cms/delivery/_cache/statsPOST /api/v1/cms/delivery/_cache/clearGET /api/v1/cms/delivery/{type_slug}/{entry_id}GET /api/v1/cms/media/foldersPOST /api/v1/cms/media/foldersDELETE /api/v1/cms/media/folders/{folder_id}GET /api/v1/cms/mediaGET /api/v1/cms/media/{media_id}PATCH /api/v1/cms/media/{media_id}DELETE /api/v1/cms/media/{media_id}POST /api/v1/cms/media/uploadPOST /api/v1/cms/media/{media_id}/movePOST /api/v1/cms/media/{media_id}/generate-variantsPOST /api/v1/cms/media/bulk-deletePOST /api/v1/cms/media/bulk-moveGET /api/v1/cms/webhooksPOST /api/v1/cms/webhooksGET /api/v1/cms/webhooks/{webhook_id}PATCH /api/v1/cms/webhooks/{webhook_id}DELETE /api/v1/cms/webhooks/{webhook_id}POST /api/v1/cms/webhooks/{webhook_id}/testGET /api/v1/cms/webhooks/{webhook_id}/deliveriesGET /api/v1/cms/webhooks/{webhook_id}/deliveries/{delivery_id}POST /api/v1/cms/webhooks/{webhook_id}/deliveries/{delivery_id}/retryGET /api/v1/cms/webhooks/events/supportedGET /Additional current operationsDELETE /api/v1/phone-numbers/{phone_number_id}GET /api/v1/cms/content/{type_slug}/exportGET /api/v1/projects/{project_id}/phone-numbersGET /api/v1/telephony/numbers/searchPOST /api/v1/billing/webhooks/flutterwavePOST /api/v1/cms/content/{type_slug}/importPOST /api/v1/cms/content/{type_slug}/publishPOST /api/v1/credits/flutterwave/checkoutPOST /api/v1/projects/{project_id}/phone-numbersPOST /api/v1/voice/sessionPOST /api/v1/voice/session/{session_id}/endPOST /api/v1/voice/toolPOST /webhooks/email/agentmailPOST /webhooks/flutterwavePOST /webhooks/telephony/telnyxPOST /webhooks/telephony/vonage/answerPOST /webhooks/telephony/vonage/event