# Vatel AI Documentation

## Docs

- [Create agent](https://docs.vatel.ai/api-reference/agents/create-agent.md): Creates a new agent; optional fields override server defaults.
- [Delete agent](https://docs.vatel.ai/api-reference/agents/delete-agent.md)
- [Dial outbound (Twilio or SIP trunk)](https://docs.vatel.ai/api-reference/agents/dial.md): Call a phone number with this agent. Provide `number` or `destination` (same meaning). Optionally use a SIP trunk, override the opening message or prompt, and pass variables in the request body.
- [Get agent](https://docs.vatel.ai/api-reference/agents/get-agent.md)
- [Get agent version with nodes](https://docs.vatel.ai/api-reference/agents/get-agent-graph-version.md)
- [List agent versions](https://docs.vatel.ai/api-reference/agents/list-agent-graph-versions.md)
- [List agents](https://docs.vatel.ai/api-reference/agents/list-agents.md): All agents owned by the organization for the current API key.
- [Publish agent version](https://docs.vatel.ai/api-reference/agents/publish-agent-graph-version.md): Publish this agent version and set it as the active version. Returns 409 if the version was already published.
- [Update agent](https://docs.vatel.ai/api-reference/agents/update-agent.md)
- [Download call recording](https://docs.vatel.ai/api-reference/calls/download-call-recording.md): Streams the WAV recording for the call (`{id}.wav` in storage). Response body is raw audio with `Content-Disposition: attachment`. Errors are JSON.
- [Get call](https://docs.vatel.ai/api-reference/calls/get-call.md): Returns one call by id if it belongs to an organization you can access.
- [List calls](https://docs.vatel.ai/api-reference/calls/list-calls.md): Paginated calls for the organization tied to your API key. Filter with optional query parameters. When using the internal server API key (`Authorization: Bearer` or `API-KEY` matching server config), you must send `organization_id` as a query parameter (UUID).
- [Introduction](https://docs.vatel.ai/api-reference/introduction.md): Overview of the Vatel AI REST and WebSocket APIs for building and managing voice agents.
- [List agent-allowed LLM model strings](https://docs.vatel.ai/api-reference/llms/list-llms.md): Returns sorted identifiers you may use for an agent's primary and fallback models. Values are `provider/model` strings.
- [Get current organization](https://docs.vatel.ai/api-reference/organization/get-organization.md): Resolve id and name for the organization that owns the API key.
- [Connection](https://docs.vatel.ai/api-reference/session/connection.md): Single bidirectional channel. Client receives session/audio/transcript messages; client sends input audio. Connect with ?token={jwt} where the JWT is obtained from POST /v1/session-token.
- [Generate session token](https://docs.vatel.ai/api-reference/session/session-token.md): Get credentials to start a voice or chat session with an agent. Specify `agent_id` and optionally the agent version, transport (`websocket` or `webrtc`), opening message, prompt, chat access, and custom variables.
- [Create SIP trunk](https://docs.vatel.ai/api-reference/sip-trunks/create-sip-trunk.md)
- [Create agent assignment on SIP trunk](https://docs.vatel.ai/api-reference/sip-trunks/create-sip-trunk-agent-assignment.md): Maps an org agent to this trunk. Use `number` when inbound auth is digest (unique on this trunk). Use `alternate_number` when inbound auth is ACL (globally unique alternate dial target). Same rules as the dashboard integrations UI.
- [Delete SIP trunk](https://docs.vatel.ai/api-reference/sip-trunks/delete-sip-trunk.md)
- [Delete SIP trunk assignment](https://docs.vatel.ai/api-reference/sip-trunks/delete-sip-trunk-agent-assignment.md): Assignment id is globally unique.
- [Get SIP trunk](https://docs.vatel.ai/api-reference/sip-trunks/get-sip-trunk.md)
- [Get SIP trunk assignment](https://docs.vatel.ai/api-reference/sip-trunks/get-sip-trunk-agent-assignment.md)
- [List agent assignments on SIP trunk](https://docs.vatel.ai/api-reference/sip-trunks/list-sip-trunk-agent-assignments.md)
- [List SIP trunks](https://docs.vatel.ai/api-reference/sip-trunks/list-sip-trunks.md)
- [Update SIP trunk](https://docs.vatel.ai/api-reference/sip-trunks/update-sip-trunk.md)
- [Update SIP trunk assignment](https://docs.vatel.ai/api-reference/sip-trunks/update-sip-trunk-agent-assignment.md): Patch `number` and/or `alternate_number`. Send `null` to clear a field. Omitted keys are left unchanged. Assignment id is globally unique.
- [Import Twilio phone number](https://docs.vatel.ai/api-reference/twilio/import-twilio-number.md)
- [List imported Twilio numbers](https://docs.vatel.ai/api-reference/twilio/list-twilio-numbers.md)
- [Update Twilio number label](https://docs.vatel.ai/api-reference/twilio/update-twilio-number-label.md)
- [List aggregated TTS voices](https://docs.vatel.ai/api-reference/voices/list-voices.md): Combined catalog of voices you can reference in agent `voice_settings`. The list may vary by environment and provider availability.
- [Agent Editor Overview](https://docs.vatel.ai/configure/agent-editor.md): Build your agent's conversation flow and tools
- [Flows](https://docs.vatel.ai/configure/flows.md)
- [Graph Node Types](https://docs.vatel.ai/configure/nodes.md): Reference for all node types in the agent editor
- [Configuration Overview](https://docs.vatel.ai/configure/overview.md): Fundamental concepts for building and managing AI agents
- [Prompt engineering](https://docs.vatel.ai/configure/prompting.md): Writing effective prompts for your agents
- [Client tools](https://docs.vatel.ai/configure/tools/client-tools.md): Tools executed by your client via the API. How they differ from function-node tools and how to use them over the WebSocket and SDKs.
- [Function Nodes](https://docs.vatel.ai/configure/tools/function-nodes.md): Nodes in the agent editor that become tools
- [Tools Overview](https://docs.vatel.ai/configure/tools/overview.md): Function nodes, system tools, and client-defined tools
- [Server tools](https://docs.vatel.ai/configure/tools/server-tools.md)
- [Variables](https://docs.vatel.ai/configure/variables.md)
- [Version Control](https://docs.vatel.ai/configure/version-control.md): Drafts, publishing, and activating versions
- [Voices](https://docs.vatel.ai/configure/voices.md): Choose the right voice for your agent
- [Go SDK Example](https://docs.vatel.ai/deploy/examples/golang-cli.md): Run a full-duplex voice session from the command line with the Go SDK: microphone to agent, agent audio to speaker and optional PCM file.
- [Next.js](https://docs.vatel.ai/deploy/examples/nextjs.md): Run a Session WebSocket demo in Next.js with server-side session tokens and real-time voice.
- [Python SDK Example](https://docs.vatel.ai/deploy/examples/python-cli.md): Run a full-duplex voice session from the command line with the Python SDK: microphone to agent, agent audio to speaker.
- [Full-stack Next.js demo](https://docs.vatel.ai/deploy/examples/vatel-full-stack.md): Clone-ready Next.js app: manage agents, start live calls, browse history, and play recordings with the official JavaScript SDK.
- [WebRTC (browser)](https://docs.vatel.ai/deploy/examples/webrtc-browser.md): Use @vatel/sdk WebRTCSession in the browser with webrtc_token, url, room, and identity from POST /v1/session-token.
- [Deploy Overview](https://docs.vatel.ai/deploy/overview.md): Connect your agents to telephony and integrate with your stack using SDKs
- [Go SDK](https://docs.vatel.ai/deploy/sdk/go.md): Use the Vatel REST and WebSocket APIs from Go. Run real-time voice sessions and access the API with a single client.
- [JavaScript / TypeScript SDK](https://docs.vatel.ai/deploy/sdk/javascript.md): Connect to Vatel voice agents from JavaScript or TypeScript. Run real-time voice sessions and access the API in Node.js or the browser.
- [SDK Overview](https://docs.vatel.ai/deploy/sdk/overview.md): Integrate Vatel voice agents into your applications with official SDKs for Python, JavaScript, and Go.
- [Python SDK](https://docs.vatel.ai/deploy/sdk/python.md): Use the Vatel REST and WebSocket APIs from Python. Run real-time voice sessions and access the API with async support.
- [SIP Trunking](https://docs.vatel.ai/deploy/telephony/sip.md): Connect your agents via SIP for maximum flexibility and carrier choice
- [AI Receptionist](https://docs.vatel.ai/getting-started/ai-receptionist.md): Deploy your first AI phone receptionist agent
- [Vatel AI](https://docs.vatel.ai/index.md)
- [Activix CRM](https://docs.vatel.ai/integrations/activix-crm.md): Real estate and property CRM
- [Applied Epic API](https://docs.vatel.ai/integrations/applied-epic.md): Insurance agency management and CRM
- [Asana API](https://docs.vatel.ai/integrations/asana.md): Project and task management for your agents
- [Booking.com Demand API](https://docs.vatel.ai/integrations/booking-com.md): Hotel and accommodation bookings
- [Cal.com API](https://docs.vatel.ai/integrations/cal-com.md): Scheduling and calendar bookings for your agents
- [Calendly API](https://docs.vatel.ai/integrations/calendly.md): Scheduling and appointment booking
- [Clerk](https://docs.vatel.ai/integrations/clerk.md): User authentication and management for your app
- [ClickUp v2 API](https://docs.vatel.ai/integrations/clickup.md): Project management and tasks for your agents
- [ConnectWise](https://docs.vatel.ai/integrations/connectwise.md): PSA and service desk for MSPs
- [MailerSend](https://docs.vatel.ai/integrations/email/mailersend.md): Send emails from your agents
- [EnvisionCloud](https://docs.vatel.ai/integrations/envisioncloud.md): Industry-specific cloud platform
- [Fortellis CRM](https://docs.vatel.ai/integrations/fortellis-crm.md): Automotive industry CRM and data
- [Freshdesk](https://docs.vatel.ai/integrations/freshdesk.md): Help desk and customer support
- [GitHub v3 API](https://docs.vatel.ai/integrations/github.md): Repository and development workflow integration
- [GitLab v4 API](https://docs.vatel.ai/integrations/gitlab.md): Repository and DevOps workflow integration
- [Google Bookings API](https://docs.vatel.ai/integrations/google-bookings.md): Google Business Profile bookings and appointments
- [HubSpot CMS API](https://docs.vatel.ai/integrations/hubspot-cms.md): HubSpot CMS and content management
- [HubSpot CRM API](https://docs.vatel.ai/integrations/hubspot-crm.md): HubSpot CRM contacts, deals, and companies
- [HubSpot Automation Sequences API](https://docs.vatel.ai/integrations/hubspot-sequences.md): HubSpot sequences and email automation
- [HubSpot V4 Workflows API](https://docs.vatel.ai/integrations/hubspot-workflows.md): HubSpot workflow automation
- [Intercom API](https://docs.vatel.ai/integrations/intercom.md): Customer messaging and support
- [Jas Connect V2](https://docs.vatel.ai/integrations/jas-connect.md): Jas Connect integration
- [Mailchimp API](https://docs.vatel.ai/integrations/mailchimp.md): Email marketing and audiences
- [n8n Public API](https://docs.vatel.ai/integrations/n8n.md): Workflow automation and integrations
- [Notion API](https://docs.vatel.ai/integrations/notion.md): Notes, databases, and wikis for your agents
- [OpenPhone Public API](https://docs.vatel.ai/integrations/openphone.md): Business phone and calling
- [OpenTable](https://docs.vatel.ai/integrations/opentable.md): Restaurant reservations and dining
- [Integrations Overview](https://docs.vatel.ai/integrations/overview.md): Connect Vatel AI agents with external services
- [PayPal API](https://docs.vatel.ai/integrations/paypal.md): Payments and transactions for your agents
- [Pipedrive v1 API](https://docs.vatel.ai/integrations/pipedrive-v1.md): CRM and sales pipeline management
- [Pipedrive v2 API](https://docs.vatel.ai/integrations/pipedrive-v2.md): CRM and sales pipeline management (v2)
- [Plaid API](https://docs.vatel.ai/integrations/plaid.md): Banking and financial data connectivity
- [QuickBooks Online API](https://docs.vatel.ai/integrations/quickbooks-online.md): Accounting and financial data for your agents
- [Resend](https://docs.vatel.ai/integrations/resend.md): Send emails from your agents
- [Slack API](https://docs.vatel.ai/integrations/slack.md): Slack messaging and notifications for your agents
- [Stripe](https://docs.vatel.ai/integrations/stripe.md): Payments and billing for your agents
- [Twilio](https://docs.vatel.ai/integrations/twilio.md): Voice and SMS for your agents
- [WhatsApp Cloud API](https://docs.vatel.ai/integrations/whatsapp-cloud.md): WhatsApp messaging for your agents
- [Xero Accounting API](https://docs.vatel.ai/integrations/xero.md): Accounting and bookkeeping for your agents
- [Call Analytics](https://docs.vatel.ai/monitor/call-analytics.md): Call history, transcription, recording, extracted variables and much more.
- [Chat Bot](https://docs.vatel.ai/monitor/testing/cekura/chat-testing.md): Connect Cekura to a Vatel agent over WebSocket to run chat evaluations.
- [Overview](https://docs.vatel.ai/monitor/testing/cekura/overview.md): What Cekura is, how it fits Vatel testing, and links to chat and SIP guides.
- [SIP Calls](https://docs.vatel.ai/monitor/testing/cekura/sip-testing.md): Point Cekura at a Vatel SIP trunk so it can place evaluation calls to your agent.

## OpenAPI Specs

- [openapi](https://docs.vatel.ai/openapi.json)

## AsyncAPI Specs

- [asyncapi](https://docs.vatel.ai/asyncapi.json)

## Optional

- [Home](https://vatel.ai)
- [Console](https://console.vatel.ai)