THE VOICE THAT PICKS UP
Sawt
Get started
← Docs

API reference

Every endpoint, generated from the running service — so nothing here describes something that does not exist, and nothing that exists is missing.

138 endpoints · 27 groupsMarkdownllms.txt
Authentication
curl https://api.sawtai.app/agents/ \
  -H "Authorization: Bearer $SAWT_API_KEY"

Agents

GET/agents/

List Agents

authorization(header)X-Organization-Id(header)
POST/agents/JSON body

Create Agent

authorization(header)X-Organization-Id(header)
DELETE/agents/{agent_id}

Delete Agent

agent_id(path, required)authorization(header)X-Organization-Id(header)
GET/agents/{agent_id}

Get Agent

agent_id(path, required)authorization(header)X-Organization-Id(header)
PATCH/agents/{agent_id}JSON body

Update Agent

agent_id(path, required)authorization(header)X-Organization-Id(header)
GET/agents/{agent_id}/knowledge

List Knowledge

agent_id(path, required)authorization(header)X-Organization-Id(header)
POST/agents/{agent_id}/knowledgeJSON body

Add Knowledge

agent_id(path, required)authorization(header)X-Organization-Id(header)
GET/agents/{agent_id}/simulations

List Simulations

agent_id(path, required)authorization(header)X-Organization-Id(header)
POST/agents/{agent_id}/simulationsJSON body

Start Simulation

agent_id(path, required)authorization(header)X-Organization-Id(header)
GET/agents/{agent_id}/simulations/{sim_id}

Get Simulation

agent_id(path, required)sim_id(path, required)authorization(header)X-Organization-Id(header)
GET/agents/{agent_id}/versions

List Agent Versions

agent_id(path, required)authorization(header)X-Organization-Id(header)
GET/agents/{agent_id}/versions/{version}

Get Agent Version

agent_id(path, required)version(path, required)authorization(header)X-Organization-Id(header)
POST/agents/{agent_id}/versions/{version}/restore

Restore Agent Version

agent_id(path, required)version(path, required)authorization(header)X-Organization-Id(header)
POST/agents/draftJSON body

Draft Agent Endpoint

authorization(header)X-Organization-Id(header)
DELETE/agents/knowledge/{item_id}

Delete Knowledge

item_id(path, required)authorization(header)X-Organization-Id(header)
POST/agents/knowledge/{item_id}/mediaJSON body

Attach Knowledge Media

item_id(path, required)authorization(header)X-Organization-Id(header)

Calls

GET/calls/

List Calls

page(query)limit(query)direction(query)status(query)agent_id(query)authorization(header)X-Organization-Id(header)
GET/calls/{call_id}

Get Call

call_id(path, required)authorization(header)X-Organization-Id(header)
DELETE/calls/{call_id}/recording

Delete Recording

call_id(path, required)authorization(header)X-Organization-Id(header)
GET/calls/{call_id}/recording

Get Recording

call_id(path, required)authorization(header)X-Organization-Id(header)

Analytics

GET/analytics/calls.csv

Calls Csv

days(query)authorization(header)X-Organization-Id(header)
GET/analytics/overview

Overview

days(query)authorization(header)X-Organization-Id(header)

Numbers

GET/numbers/

List Numbers

authorization(header)X-Organization-Id(header)
DELETE/numbers/{number_id}

Release Phone Number

number_id(path, required)authorization(header)X-Organization-Id(header)
PATCH/numbers/{number_id}/assignJSON body

Assign Agent

number_id(path, required)authorization(header)X-Organization-Id(header)
PATCH/numbers/{number_id}/forwardingJSON body

Set Forwarding

number_id(path, required)authorization(header)X-Organization-Id(header)
POST/numbers/purchaseJSON body

Purchase Phone Number

authorization(header)X-Organization-Id(header)
GET/numbers/sandbox-access

Sandbox Access

authorization(header)X-Organization-Id(header)
POST/numbers/searchJSON body

Search Numbers

authorization(header)X-Organization-Id(header)

SIP endpoints

GET/sip/

List Endpoints

authorization(header)X-Organization-Id(header)
POST/sip/JSON body

Create Endpoint

authorization(header)X-Organization-Id(header)
DELETE/sip/{endpoint_id}

Delete Endpoint

endpoint_id(path, required)authorization(header)X-Organization-Id(header)
PATCH/sip/{endpoint_id}JSON body

Update Endpoint

endpoint_id(path, required)authorization(header)X-Organization-Id(header)
POST/sip/{endpoint_id}/rotate-password

Rotate Password

endpoint_id(path, required)authorization(header)X-Organization-Id(header)

Voices

GET/voices/

List Voices

authorization(header)X-Organization-Id(header)
DELETE/voices/{voice_row_id}

Delete Voice

voice_row_id(path, required)authorization(header)X-Organization-Id(header)
POST/voices/cloneJSON body

Clone Voice

authorization(header)X-Organization-Id(header)
GET/voices/preview/{voice_key}

Voice Preview

voice_key(path, required)premium(query)authorization(header)X-Organization-Id(header)
GET/voices/voice-note-preview

Voice Note Preview

voice_id(query)authorization(header)X-Organization-Id(header)

Documents

GET/documents/

List Documents

agent_id(query, required)authorization(header)X-Organization-Id(header)
POST/documents/JSON body

Create Document

authorization(header)X-Organization-Id(header)
DELETE/documents/{document_id}

Delete Document

document_id(path, required)authorization(header)X-Organization-Id(header)
POST/documents/{document_id}/reingest

Reingest Document

document_id(path, required)authorization(header)X-Organization-Id(header)
POST/documents/crawlJSON body

Crawl Site

authorization(header)X-Organization-Id(header)
POST/documents/uploadJSON body

Upload Document

authorization(header)X-Organization-Id(header)

Function tools

GET/agents/{agent_id}/tools

List Tools

agent_id(path, required)authorization(header)X-Organization-Id(header)
PUT/agents/{agent_id}/tools/{tool_name}JSON body

Toggle Tool

agent_id(path, required)tool_name(path, required)authorization(header)X-Organization-Id(header)

Integrations

GET/integrations/

List Integrations

authorization(header)X-Organization-Id(header)
DELETE/integrations/{integration_id}

Disconnect

integration_id(path, required)authorization(header)X-Organization-Id(header)
POST/integrations/cal_com/configureJSON body

Cal Com Configure

authorization(header)X-Organization-Id(header)
POST/integrations/calendly/configureJSON body

Calendly Configure

authorization(header)X-Organization-Id(header)
POST/integrations/google/connectJSON body

Google Connect

authorization(header)X-Organization-Id(header)
POST/integrations/google/start

Google Start

authorization(header)X-Organization-Id(header)
POST/integrations/hubspot/connectJSON body

Hubspot Connect

authorization(header)X-Organization-Id(header)
POST/integrations/hubspot/start

Hubspot Start

authorization(header)X-Organization-Id(header)
PATCH/integrations/meta/{integration_id}/agentJSON body

Meta Set Agent

integration_id(path, required)authorization(header)X-Organization-Id(header)
GET/integrations/meta/config

Meta Config

authorization(header)X-Organization-Id(header)
POST/integrations/meta/connectJSON body

Meta Connect Channel

authorization(header)X-Organization-Id(header)
POST/integrations/microsoft/connectJSON body

Microsoft Connect

authorization(header)X-Organization-Id(header)
POST/integrations/microsoft/start

Microsoft Start

authorization(header)X-Organization-Id(header)
GET/integrations/providers

Provider Availability

authorization(header)X-Organization-Id(header)
POST/integrations/resend/configureJSON body

Resend Configure

authorization(header)X-Organization-Id(header)
POST/integrations/reservation_webhook/configureJSON body

Reservation Webhook Configure

authorization(header)X-Organization-Id(header)
POST/integrations/salesforce/connectJSON body

Salesforce Connect

authorization(header)X-Organization-Id(header)
POST/integrations/salesforce/start

Salesforce Start

authorization(header)X-Organization-Id(header)
POST/integrations/slack/configureJSON body

Slack Configure

authorization(header)X-Organization-Id(header)
POST/integrations/stripe/configureJSON body

Stripe Configure

authorization(header)X-Organization-Id(header)
POST/integrations/whatsapp/configureJSON body

Whatsapp Configure

authorization(header)X-Organization-Id(header)
POST/integrations/zoho/connectJSON body

Zoho Connect

authorization(header)X-Organization-Id(header)
POST/integrations/zoho/start

Zoho Start

authorization(header)X-Organization-Id(header)

Webhooks

GET/webhooks/

List Webhooks

authorization(header)X-Organization-Id(header)
POST/webhooks/JSON body

Create Webhook

authorization(header)X-Organization-Id(header)
DELETE/webhooks/{webhook_id}

Delete Webhook

webhook_id(path, required)authorization(header)X-Organization-Id(header)
PATCH/webhooks/{webhook_id}JSON body

Update Webhook

webhook_id(path, required)authorization(header)X-Organization-Id(header)
GET/webhooks/{webhook_id}/deliveries

List Deliveries

webhook_id(path, required)limit(query)authorization(header)X-Organization-Id(header)
POST/webhooks/{webhook_id}/test

Test Webhook

webhook_id(path, required)authorization(header)X-Organization-Id(header)
GET/webhooks/events

List Events

authorization(header)X-Organization-Id(header)

API keys

GET/api-keys/

List Keys

authorization(header)X-Organization-Id(header)
POST/api-keys/JSON body

Create Key

authorization(header)X-Organization-Id(header)
POST/api-keys/{key_id}/revoke

Revoke Key

key_id(path, required)authorization(header)X-Organization-Id(header)
GET/api-keys/scopes

List Scopes

authorization(header)X-Organization-Id(header)

Members

GET/members/

List Members

authorization(header)X-Organization-Id(header)
DELETE/members/{member_id}

Remove Member

member_id(path, required)authorization(header)X-Organization-Id(header)
PATCH/members/{member_id}JSON body

Update Member Role

member_id(path, required)authorization(header)X-Organization-Id(header)
GET/members/invitations

List Invitations

authorization(header)X-Organization-Id(header)
POST/members/invitationsJSON body

Create Invitation

authorization(header)X-Organization-Id(header)
DELETE/members/invitations/{invitation_id}

Revoke Invitation

invitation_id(path, required)authorization(header)X-Organization-Id(header)
POST/members/invitations/acceptJSON body

Accept Invitation

authorization(header)X-Organization-Id(header)
POST/members/transfer-ownershipJSON body

Transfer Ownership

authorization(header)X-Organization-Id(header)

Billing

GET/billing/channel-split

Get Channel Split

authorization(header)X-Organization-Id(header)
PUT/billing/channel-splitJSON body

Set Channel Split

authorization(header)X-Organization-Id(header)
GET/billing/overage

Get Overage

authorization(header)X-Organization-Id(header)
PUT/billing/overageJSON body

Set Overage

authorization(header)X-Organization-Id(header)

Jobs

GET/jobs/

List Jobs

status(query)kind(query)limit(query)authorization(header)X-Organization-Id(header)
POST/jobs/{job_id}/retry

Retry Job

job_id(path, required)authorization(header)X-Organization-Id(header)

Evals

GET/evals/dialects

List Dialect Evals

limit(query)authorization(header)X-Organization-Id(header)
POST/evals/dialects/runJSON body

Run Dialect Eval

authorization(header)X-Organization-Id(header)

Audit

GET/audit-logs/

List Audit Logs

page(query)limit(query)action(query)authorization(header)X-Organization-Id(header)
GET/audit-logs/export.csv

Export Audit Logs

action(query)since(query)authorization(header)X-Organization-Id(header)

Onboarding

POST/onboarding/JSON body

Complete Onboarding

authorization(header)X-Organization-Id(header)

Callbacks

GET/callbacks/

List Callbacks

status(query)authorization(header)X-Organization-Id(header)
POST/callbacks/{callback_id}/done

Mark Callback Done

callback_id(path, required)authorization(header)X-Organization-Id(header)

Catalog

GET/catalog/

List Items

agent_id(query, required)q(query)limit(query)offset(query)authorization(header)X-Organization-Id(header)
POST/catalog/JSON body

Create Item

authorization(header)X-Organization-Id(header)
DELETE/catalog/{item_id}

Delete Item

item_id(path, required)authorization(header)X-Organization-Id(header)
PATCH/catalog/{item_id}JSON body

Update Item

item_id(path, required)authorization(header)X-Organization-Id(header)
POST/catalog/{item_id}/photoJSON body

Attach Photo

item_id(path, required)authorization(header)X-Organization-Id(header)
POST/catalog/bulkJSON body

Create Items

authorization(header)X-Organization-Id(header)
GET/catalog/misses

List Misses

agent_id(query, required)limit(query)authorization(header)X-Organization-Id(header)
DELETE/catalog/misses/{miss_id}

Dismiss Miss

miss_id(path, required)authorization(header)X-Organization-Id(header)
POST/catalog/parseJSON body

Parse Lines

authorization(header)X-Organization-Id(header)

Conversations

GET/conversations/

List Conversations

channel(query)needs_attention(query)status(query)assignee(query)authorization(header)X-Organization-Id(header)
GET/conversations/{conversation_id}

Get Conversation

conversation_id(path, required)authorization(header)X-Organization-Id(header)
PATCH/conversations/{conversation_id}JSON body

Update Thread

conversation_id(path, required)authorization(header)X-Organization-Id(header)
POST/conversations/{conversation_id}/csat

Request Csat

conversation_id(path, required)authorization(header)X-Organization-Id(header)
POST/conversations/{conversation_id}/notesJSON body

Add Note

conversation_id(path, required)authorization(header)X-Organization-Id(header)
POST/conversations/{conversation_id}/replyJSON body

Reply

conversation_id(path, required)authorization(header)X-Organization-Id(header)

Custom tools

GET/custom-tools/

List Custom Tools

authorization(header)X-Organization-Id(header)
POST/custom-tools/JSON body

Create Custom Tool

authorization(header)X-Organization-Id(header)
DELETE/custom-tools/{tool_id}

Delete Custom Tool

tool_id(path, required)authorization(header)X-Organization-Id(header)
PATCH/custom-tools/{tool_id}JSON body

Update Custom Tool

tool_id(path, required)authorization(header)X-Organization-Id(header)
POST/custom-tools/{tool_id}/testJSON body

Test Custom Tool

tool_id(path, required)authorization(header)X-Organization-Id(header)

Live

GET/live/calls

List Live Calls

authorization(header)X-Organization-Id(header)
POST/live/calls/{call_sid}/token

Live Call Token

call_sid(path, required)authorization(header)X-Organization-Id(header)

Mcp servers

GET/mcp-servers/

List Servers

authorization(header)X-Organization-Id(header)
POST/mcp-servers/JSON body

Create Server

authorization(header)X-Organization-Id(header)
DELETE/mcp-servers/{server_id}

Delete Server

server_id(path, required)authorization(header)X-Organization-Id(header)
PATCH/mcp-servers/{server_id}JSON body

Update Server

server_id(path, required)authorization(header)X-Organization-Id(header)
POST/mcp-servers/{server_id}/sync

Sync Now

server_id(path, required)authorization(header)X-Organization-Id(header)

Orders

GET/orders/

List Orders

status(query)agent_id(query)limit(query)offset(query)authorization(header)X-Organization-Id(header)
GET/orders/{order_id}

Get Order

order_id(path, required)authorization(header)X-Organization-Id(header)
PATCH/orders/{order_id}JSON body

Decide

order_id(path, required)authorization(header)X-Organization-Id(header)

Other

GET/health

Health Check

deep(query)
GET/health/deep

Deep Health Check

Sso

GET/sso/lookup

Lookup

email(query)

Workspace

GET/workspace/

Get Workspace

authorization(header)X-Organization-Id(header)
PATCH/workspace/JSON body

Update Workspace

authorization(header)X-Organization-Id(header)
GET/workspace/timezones

List Timezones

authorization(header)X-Organization-Id(header)