# Vorbal | Documentation

> Build reliable calling experiences with Vorbal APIs for calls, media, messaging, and webhooks.

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.vorbal.dev/_mcp/server

## Docs

- [Vorbal](https://docs.vorbal.dev/welcome.md): Build reliable calling experiences without managing voice infrastructure.
- [Getting started](https://docs.vorbal.dev/quickstart.md): Place a call and play audio in three steps.
- [Build a simple voicemail](https://docs.vorbal.dev/build-simple-voicemail.md): Play saved messages for one caller and record messages from everyone else.
- [Handling asynchronous commands](https://docs.vorbal.dev/async-operations.md): Correlate accepted commands with lifecycle webhooks
- [Formats](https://docs.vorbal.dev/formats.md): Conventions for values and responses across the API.
- [Error handling](https://docs.vorbal.dev/errors.md): Understand and handle API errors consistently.
- [Rate limits](https://docs.vorbal.dev/rate-limits.md): Understand request limits and handle traffic safely.
- [Idempotency](https://docs.vorbal.dev/idempotency.md): Retry requests safely without repeating an operation.
- [Roadmap](https://docs.vorbal.dev/roadmap.md): Capabilities planned for future releases.
- [API overview](https://docs.vorbal.dev/api.md): Core concepts of the API
- [Authentication](https://docs.vorbal.dev/api/authentication.md): Authenticate API requests.
- [API changelog](https://docs.vorbal.dev/api/api-changelog.md): Integration-relevant changes to the Vorbal API
- [Event delivery](https://docs.vorbal.dev/api/event-delivery.md): Understand webhook metadata, signature verification, retries, failures, and event ordering.
- [Session](https://docs.vorbal.dev/api/sessions.md): Complete Session resource and lifecycle-event reference, including payload schemas and examples.
- [WebSocket overview](https://docs.vorbal.dev/api/web-socket.md): Complete WebSocket Session connection and lifecycle-event reference.
- [Room](https://docs.vorbal.dev/api/rooms.md): Complete Room resource and event reference for room lifecycle, participants, and room playback.
- [RoomParticipant](https://docs.vorbal.dev/api/room-participants.md): Room-participant API overview; complete participant lifecycle-event schemas and examples are in the Room overview.
- [Room Playback overview](https://docs.vorbal.dev/api/room-playback.md): Room Playback API overview; complete room-playback event schemas and examples are in the Room overview.
- [Recording](https://docs.vorbal.dev/api/recording.md): Complete Recording resource and lifecycle-event reference, including speech-activity events and payload examples.
- [Playback overview](https://docs.vorbal.dev/api/playback.md): Complete Session playback command and lifecycle-event reference, including payload schemas and examples.
- [Keypad (DTMF)](https://docs.vorbal.dev/api/keypad-input.md): Complete keypad-input command and event reference for individual DTMF presses and collected digits.
- [Message](https://docs.vorbal.dev/api/messages.md): Complete Message resource and lifecycle-event reference for outbound SMS.

## API Docs

- API Overview > Event delivery [Webhook signature public keys](https://docs.vorbal.dev/api/event-delivery/webhooks/get-webhook-public-keys.md)
- API Overview > Sessions & Calls [List sessions](https://docs.vorbal.dev/api/sessions/list.md)
- API Overview > Sessions & Calls [Get session details](https://docs.vorbal.dev/api/sessions/get.md)
- API Overview > Sessions & Calls [Originate outbound call](https://docs.vorbal.dev/api/sessions/dial.md)
- API Overview > Sessions & Calls [Answer a call](https://docs.vorbal.dev/api/sessions/answer.md)
- API Overview > Sessions & Calls [Reject an incoming call](https://docs.vorbal.dev/api/sessions/reject.md)
- API Overview > Sessions & Calls [Cancel an unanswered outgoing call](https://docs.vorbal.dev/api/sessions/cancel.md)
- API Overview > Sessions & Calls [Delete session](https://docs.vorbal.dev/api/sessions/delete.md)
- API Overview > WebSocket [Create a WebSocket session](https://docs.vorbal.dev/api/web-socket/connect-websocket.md)
- API Overview > Rooms [List rooms](https://docs.vorbal.dev/api/rooms/list.md)
- API Overview > Rooms [Get room status](https://docs.vorbal.dev/api/rooms/get.md)
- API Overview > Rooms [Create a room](https://docs.vorbal.dev/api/rooms/create.md)
- API Overview > Rooms [Delete room](https://docs.vorbal.dev/api/rooms/delete.md)
- API Overview > Room Participants [List room participants](https://docs.vorbal.dev/api/room-participants/list.md)
- API Overview > Room Participants [Add a session to the room](https://docs.vorbal.dev/api/room-participants/add.md)
- API Overview > Room Participants [Get a single room participant](https://docs.vorbal.dev/api/room-participants/get.md)
- API Overview > Room Participants [Remove a participant from the room](https://docs.vorbal.dev/api/room-participants/remove.md)
- API Overview > Room Participants [Mute room participant](https://docs.vorbal.dev/api/room-participants/mute.md)
- API Overview > Room Participants [Unmute room participant](https://docs.vorbal.dev/api/room-participants/unmute.md)
- API Overview > Room Participants [Set room participant volume](https://docs.vorbal.dev/api/room-participants/volume.md)
- API Overview > Room Playback [Play audio in room](https://docs.vorbal.dev/api/room-playback/play.md)
- API Overview > Room Playback [Pause room playback](https://docs.vorbal.dev/api/room-playback/pause.md)
- API Overview > Room Playback [Start recording room audio](https://docs.vorbal.dev/api/room-playback/start-recording.md)
- API Overview > Room Playback [Stop recording room audio](https://docs.vorbal.dev/api/room-playback/stop-recording.md)
- API Overview > Room Playback [Seek room playback](https://docs.vorbal.dev/api/room-playback/seek.md)
- API Overview > Room Playback [Stop room playback](https://docs.vorbal.dev/api/room-playback/stop.md)
- API Overview > Room Playback [Set room playback volume](https://docs.vorbal.dev/api/room-playback/volume.md)
- API Overview > Room Playback [Resume room playback](https://docs.vorbal.dev/api/room-playback/resume-room-playback.md)
- API Overview > Recording [List session recordings](https://docs.vorbal.dev/api/recording/list.md)
- API Overview > Recording [Get a session recording](https://docs.vorbal.dev/api/recording/get.md)
- API Overview > Recording [Start recording](https://docs.vorbal.dev/api/recording/create.md)
- API Overview > Recording [Stop recording](https://docs.vorbal.dev/api/recording/stop.md)
- API Overview > Recording [Mask (pause writing) the active recording](https://docs.vorbal.dev/api/recording/mask.md)
- API Overview > Recording [Unmask (resume writing) the active recording](https://docs.vorbal.dev/api/recording/unmask.md)
- API Overview > Playback [Start audio playback](https://docs.vorbal.dev/api/playback/play.md)
- API Overview > Playback [Pause playback](https://docs.vorbal.dev/api/playback/pause.md)
- API Overview > Playback [Resume playback](https://docs.vorbal.dev/api/playback/resume.md)
- API Overview > Playback [Seek within playback](https://docs.vorbal.dev/api/playback/seek.md)
- API Overview > Playback [Restart playback](https://docs.vorbal.dev/api/playback/restart.md)
- API Overview > Playback [Stop playback](https://docs.vorbal.dev/api/playback/stop.md)
- API Overview > Playback [Upload pushed playback audio](https://docs.vorbal.dev/api/playback/upload-playback-audio.md)
- API Overview > Keypad (DTMF) [Collect DTMF input with optional playback](https://docs.vorbal.dev/api/keypad-input/collect.md)
- API Overview > Keypad (DTMF) [Cancel in-progress DTMF collection](https://docs.vorbal.dev/api/keypad-input/cancel.md)
- API Overview > Keypad (DTMF) [Send DTMF sequence](https://docs.vorbal.dev/api/keypad-input/send.md)
- API Overview > Keypad (DTMF) [Cancel outbound DTMF sequence](https://docs.vorbal.dev/api/keypad-input/cancel-dtmf-send.md)
- API Overview > Payments [Collect a payment card](https://docs.vorbal.dev/api/payments/collect-secure-payment-card.md)
- API Overview > Payments [Cancel payment-card collection](https://docs.vorbal.dev/api/payments/cancel-secure-payment-card-collection.md)
- API Overview > Payments [Collect CVV](https://docs.vorbal.dev/api/payments/collect-secure-payment-cvv.md)
- API Overview > Payments [Cancel CVV collection](https://docs.vorbal.dev/api/payments/cancel-secure-payment-cvv-collection.md)
- API Overview > Payments [Create a charge](https://docs.vorbal.dev/api/payments/create-secure-payment-charge.md)
- API Overview > Messages [List messages](https://docs.vorbal.dev/api/messages/list-messages.md)
- API Overview > Messages [Send an outbound SMS message](https://docs.vorbal.dev/api/messages/create-message.md)
- API Overview > Messages [Get SMS message status](https://docs.vorbal.dev/api/messages/get-message-status.md)
- API Overview > Application configuration [Get application configuration](https://docs.vorbal.dev/api/application-configuration/get-application-configuration.md)
- API Overview > Application configuration [Update application configuration](https://docs.vorbal.dev/api/application-configuration/update-application-configuration.md)
- API Overview > Health [Health check](https://docs.vorbal.dev/api/health/health-check.md)
- API Overview > Health [Liveness probe](https://docs.vorbal.dev/api/health/liveness-check.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.vorbal.dev/openapi.json)
- [OpenAPI YAML](https://docs.vorbal.dev/openapi.yaml)