# Leamout

- [Introduction](https://docs.leamout.com/index.md): Build and operate programmable communications with control over runtime placement and carrier connectivity.
- [Quickstart](https://docs.leamout.com/quickstart.md): Make an authenticated Leamout API request and create a voice application.
- [Authentication](https://docs.leamout.com/authentication.md): Authenticate API clients with organization bearer credentials and understand session-based organization context.
- [Core concepts](https://docs.leamout.com/concepts/core-concepts.md): The resource and deployment model behind Leamout communications.
- [Organizations](https://docs.leamout.com/guides/platform/organizations.md): Understand Leamout's tenant boundary and organization access model.
- [Members](https://docs.leamout.com/guides/platform/members.md): Manage users and roles inside an organization.
- [API credentials](https://docs.leamout.com/guides/platform/api-credentials.md): Create scoped organization bearer credentials for applications and automation.
- [Voice overview](https://docs.leamout.com/guides/voice/overview.md): How Leamout models programmable voice, call state, routing, and media control.
- [Voice applications](https://docs.leamout.com/guides/voice/voice-applications.md): Create voice applications and bind inbound resources to them.
- [Make an outbound call](https://docs.leamout.com/guides/voice/outbound-call.md): Create an outbound call after Leamout resolves a usable telecom route.
- [Receive a call](https://docs.leamout.com/guides/voice/inbound-call.md): Route authenticated inbound SIP traffic to a voice application and control the durable call.
- [Call control](https://docs.leamout.com/guides/voice/call-control.md): Answer, hang up, transfer, hold, play media, record, and send DTMF on durable calls.
- [Call events](https://docs.leamout.com/guides/voice/call-events.md): Consume normalized call lifecycle events from Leamout.
- [Recordings](https://docs.leamout.com/guides/voice/recordings.md): Inspect recording lifecycle state and obtain playback URLs.
- [Conferences](https://docs.leamout.com/guides/voice/conferences.md): Create conferences and manage participant media state.
- [Connectivity overview](https://docs.leamout.com/guides/connectivity/overview.md): How carrier connections, trunks, endpoints, and numbers form a telecom route.
- [Bring your own carrier](https://docs.leamout.com/guides/connectivity/byoc.md): Configure a generic SIP carrier and route inbound and outbound calls over your own provider.
- [Carrier connections](https://docs.leamout.com/guides/connectivity/carrier-connections.md): Configure carrier identity, authentication, limits, source IPs, and validation.
- [SIP trunks](https://docs.leamout.com/guides/connectivity/sip-trunks.md): Create BYOC or managed trunks and configure physical SIP endpoints.
- [Routing](https://docs.leamout.com/guides/connectivity/routing.md): Understand how Leamout resolves outbound routes and inbound ownership.
- [Phone numbers](https://docs.leamout.com/guides/connectivity/phone-numbers.md): Manage BYOC and managed number resources and carrier ownership.
- [SIP domains](https://docs.leamout.com/guides/sip-webrtc/sip-domains.md): Create organization-owned SIP namespaces for subscribers and browser clients.
- [SIP subscribers](https://docs.leamout.com/guides/sip-webrtc/sip-subscribers.md): Provision SIP identities and rotate subscriber credentials.
- [Browser clients](https://docs.leamout.com/guides/sip-webrtc/browser-clients.md): Register a browser SIP client over WSS and force media through TURN when required.
- [WebSocket registration](https://docs.leamout.com/guides/sip-webrtc/websocket-registration.md): Register SIP subscribers to Leamout over secure WebSocket.
- [ICE & TURN](https://docs.leamout.com/guides/sip-webrtc/ice-turn.md): Request short-lived TURN credentials for browser media.
- [Webhooks overview](https://docs.leamout.com/guides/webhooks/overview.md): Subscribe HTTPS endpoints to Leamout domain events.
- [Events](https://docs.leamout.com/guides/webhooks/events.md): Understand the webhook delivery envelope and event subscriptions.
- [Verify webhooks](https://docs.leamout.com/guides/webhooks/verification.md): Verify Leamout webhook signatures using the timestamp and raw request body.
- [Retries](https://docs.leamout.com/guides/webhooks/retries.md): Inspect webhook delivery attempts and replay failed deliveries.
- [Terminology](https://docs.leamout.com/reference/terminology.md): Canonical public terms used throughout Leamout documentation.
- [Feature availability](https://docs.leamout.com/reference/feature-availability.md): What is implemented today versus later Leamout roadmap work.
- [Limits](https://docs.leamout.com/reference/limits.md): Current API and telecom limits that are enforced by the implementation.
- [Compatibility](https://docs.leamout.com/reference/compatibility.md): API, deployment, and telecom compatibility expectations.
- [API introduction](https://docs.leamout.com/api-reference/introduction.md): Conventions shared by the Leamout v1 HTTP API.
- [API authentication](https://docs.leamout.com/api-reference/authentication.md): Use scoped organization bearer credentials with Leamout APIs.
- [Errors](https://docs.leamout.com/api-reference/errors.md): Understand Leamout's standard API error envelope and error codes.
- [Idempotency](https://docs.leamout.com/api-reference/idempotency.md): Safely retry supported mutations with Idempotency-Key.
- [Pagination](https://docs.leamout.com/api-reference/pagination.md): Current list pagination conventions.
- [Versioning](https://docs.leamout.com/api-reference/versioning.md): How Leamout versions customer HTTP APIs.
- [Create a voice application](https://docs.leamout.com/api-reference/voice-applications/create-a-voice-application.md)
- [List voice applications](https://docs.leamout.com/api-reference/voice-applications/list-voice-applications.md)
- [Get a voice application](https://docs.leamout.com/api-reference/voice-applications/get-a-voice-application.md)
- [Update a voice application](https://docs.leamout.com/api-reference/voice-applications/update-a-voice-application.md)
- [Delete a voice application](https://docs.leamout.com/api-reference/voice-applications/delete-a-voice-application.md)
- [Create a voice application binding](https://docs.leamout.com/api-reference/voice-applications/create-a-voice-application-binding.md)
- [List voice application bindings](https://docs.leamout.com/api-reference/voice-applications/list-voice-application-bindings.md)
- [Delete a voice application binding](https://docs.leamout.com/api-reference/voice-applications/delete-a-voice-application-binding.md)
- [Create an outbound call](https://docs.leamout.com/api-reference/calls/create-an-outbound-call.md)
- [List calls](https://docs.leamout.com/api-reference/calls/list-calls.md)
- [Get a call](https://docs.leamout.com/api-reference/calls/get-a-call.md)
- [Answer a call](https://docs.leamout.com/api-reference/calls/answer-a-call.md)
- [Hang up a call](https://docs.leamout.com/api-reference/calls/hang-up-a-call.md)
- [Transfer a call](https://docs.leamout.com/api-reference/calls/transfer-a-call.md)
- [Hold a call](https://docs.leamout.com/api-reference/calls/hold-a-call.md)
- [Unhold a call](https://docs.leamout.com/api-reference/calls/unhold-a-call.md)
- [Play media on a call](https://docs.leamout.com/api-reference/calls/play-media-on-a-call.md)
- [Stop call media](https://docs.leamout.com/api-reference/calls/stop-call-media.md)
- [Control call recording](https://docs.leamout.com/api-reference/calls/control-call-recording.md)
- [Send DTMF](https://docs.leamout.com/api-reference/calls/send-dtmf.md)
- [Create a SIP domain](https://docs.leamout.com/api-reference/sip-domains/create-a-sip-domain.md)
- [List SIP domains](https://docs.leamout.com/api-reference/sip-domains/list-sip-domains.md)
- [Get a SIP domain](https://docs.leamout.com/api-reference/sip-domains/get-a-sip-domain.md)
- [Update a SIP domain](https://docs.leamout.com/api-reference/sip-domains/update-a-sip-domain.md)
- [Delete a SIP domain](https://docs.leamout.com/api-reference/sip-domains/delete-a-sip-domain.md)
- [Create a SIP subscriber](https://docs.leamout.com/api-reference/sip-subscribers/create-a-sip-subscriber.md)
- [List SIP subscribers](https://docs.leamout.com/api-reference/sip-subscribers/list-sip-subscribers.md)
- [Get a SIP subscriber](https://docs.leamout.com/api-reference/sip-subscribers/get-a-sip-subscriber.md)
- [Update a SIP subscriber](https://docs.leamout.com/api-reference/sip-subscribers/update-a-sip-subscriber.md)
- [Delete a SIP subscriber](https://docs.leamout.com/api-reference/sip-subscribers/delete-a-sip-subscriber.md)
- [Rotate SIP subscriber credentials](https://docs.leamout.com/api-reference/sip-subscribers/rotate-sip-subscriber-credentials.md)
- [List carrier providers](https://docs.leamout.com/api-reference/carrier-providers/list-carrier-providers.md)
- [Get a carrier provider](https://docs.leamout.com/api-reference/carrier-providers/get-a-carrier-provider.md)
- [Create a carrier connection](https://docs.leamout.com/api-reference/carrier-connections/create-a-carrier-connection.md)
- [List carrier connections](https://docs.leamout.com/api-reference/carrier-connections/list-carrier-connections.md)
- [Get a carrier connection](https://docs.leamout.com/api-reference/carrier-connections/get-a-carrier-connection.md)
- [Update a carrier connection](https://docs.leamout.com/api-reference/carrier-connections/update-a-carrier-connection.md)
- [Delete a carrier connection](https://docs.leamout.com/api-reference/carrier-connections/delete-a-carrier-connection.md)
- [Validate a carrier connection](https://docs.leamout.com/api-reference/carrier-connections/validate-a-carrier-connection.md)
- [Set outbound carrier authentication](https://docs.leamout.com/api-reference/carrier-connections/set-outbound-carrier-authentication.md)
- [Delete outbound carrier authentication](https://docs.leamout.com/api-reference/carrier-connections/delete-outbound-carrier-authentication.md)
- [Set inbound carrier authentication](https://docs.leamout.com/api-reference/carrier-connections/set-inbound-carrier-authentication.md)
- [Delete inbound carrier authentication](https://docs.leamout.com/api-reference/carrier-connections/delete-inbound-carrier-authentication.md)
- [Add a carrier source IP](https://docs.leamout.com/api-reference/carrier-connections/add-a-carrier-source-ip.md)
- [List carrier source IPs](https://docs.leamout.com/api-reference/carrier-connections/list-carrier-source-ips.md)
- [Delete a carrier source IP](https://docs.leamout.com/api-reference/carrier-connections/delete-a-carrier-source-ip.md)
- [Create a trunk](https://docs.leamout.com/api-reference/trunks/create-a-trunk.md)
- [List trunks](https://docs.leamout.com/api-reference/trunks/list-trunks.md)
- [Get a trunk](https://docs.leamout.com/api-reference/trunks/get-a-trunk.md)
- [Update a trunk](https://docs.leamout.com/api-reference/trunks/update-a-trunk.md)
- [Delete a trunk](https://docs.leamout.com/api-reference/trunks/delete-a-trunk.md)
- [Rotate trunk credentials](https://docs.leamout.com/api-reference/trunks/rotate-trunk-credentials.md)
- [Create a trunk endpoint](https://docs.leamout.com/api-reference/trunks/create-a-trunk-endpoint.md)
- [List trunk endpoints](https://docs.leamout.com/api-reference/trunks/list-trunk-endpoints.md)
- [Get a trunk endpoint](https://docs.leamout.com/api-reference/trunks/get-a-trunk-endpoint.md)
- [Update a trunk endpoint](https://docs.leamout.com/api-reference/trunks/update-a-trunk-endpoint.md)
- [Delete a trunk endpoint](https://docs.leamout.com/api-reference/trunks/delete-a-trunk-endpoint.md)
- [Search available managed numbers](https://docs.leamout.com/api-reference/numbers/search-available-managed-numbers.md)
- [Create a number](https://docs.leamout.com/api-reference/numbers/create-a-number.md)
- [List numbers](https://docs.leamout.com/api-reference/numbers/list-numbers.md)
- [Get a number](https://docs.leamout.com/api-reference/numbers/get-a-number.md)
- [Update a number](https://docs.leamout.com/api-reference/numbers/update-a-number.md)
- [Delete a number](https://docs.leamout.com/api-reference/numbers/delete-a-number.md)
- [Assign a number to a carrier connection](https://docs.leamout.com/api-reference/numbers/assign-a-number-to-a-carrier-connection.md)
- [List recordings](https://docs.leamout.com/api-reference/recordings/list-recordings.md)
- [Get a recording](https://docs.leamout.com/api-reference/recordings/get-a-recording.md)
- [Get a recording playback URL](https://docs.leamout.com/api-reference/recordings/get-a-recording-playback-url.md)
- [Delete a recording](https://docs.leamout.com/api-reference/recordings/delete-a-recording.md)
- [Create a conference](https://docs.leamout.com/api-reference/conferences/create-a-conference.md)
- [List conferences](https://docs.leamout.com/api-reference/conferences/list-conferences.md)
- [Get a conference](https://docs.leamout.com/api-reference/conferences/get-a-conference.md)
- [End a conference](https://docs.leamout.com/api-reference/conferences/end-a-conference.md)
- [List conference participants](https://docs.leamout.com/api-reference/conferences/list-conference-participants.md)
- [Add a conference participant](https://docs.leamout.com/api-reference/conferences/add-a-conference-participant.md)
- [Remove a conference participant](https://docs.leamout.com/api-reference/conferences/remove-a-conference-participant.md)
- [Mute a conference participant](https://docs.leamout.com/api-reference/conferences/mute-a-conference-participant.md)
- [Unmute a conference participant](https://docs.leamout.com/api-reference/conferences/unmute-a-conference-participant.md)
- [Deaf a conference participant](https://docs.leamout.com/api-reference/conferences/deaf-a-conference-participant.md)
- [Undeaf a conference participant](https://docs.leamout.com/api-reference/conferences/undeaf-a-conference-participant.md)
- [Kick a conference participant](https://docs.leamout.com/api-reference/conferences/kick-a-conference-participant.md)
- [Lock a conference](https://docs.leamout.com/api-reference/conferences/lock-a-conference.md)
- [Unlock a conference](https://docs.leamout.com/api-reference/conferences/unlock-a-conference.md)
- [Issue short-lived ICE credentials](https://docs.leamout.com/api-reference/realtime/issue-short-lived-ice-credentials.md)
- [Create a webhook endpoint](https://docs.leamout.com/api-reference/webhooks/create-a-webhook-endpoint.md)
- [List webhook endpoints](https://docs.leamout.com/api-reference/webhooks/list-webhook-endpoints.md)
- [Get a webhook endpoint](https://docs.leamout.com/api-reference/webhooks/get-a-webhook-endpoint.md)
- [Update a webhook endpoint](https://docs.leamout.com/api-reference/webhooks/update-a-webhook-endpoint.md)
- [Delete a webhook endpoint](https://docs.leamout.com/api-reference/webhooks/delete-a-webhook-endpoint.md)
- [Rotate a webhook signing secret](https://docs.leamout.com/api-reference/webhooks/rotate-a-webhook-signing-secret.md)
- [Send a webhook test delivery](https://docs.leamout.com/api-reference/webhooks/send-a-webhook-test-delivery.md)
- [List webhook deliveries](https://docs.leamout.com/api-reference/webhooks/list-webhook-deliveries.md)
- [Get a webhook delivery](https://docs.leamout.com/api-reference/webhooks/get-a-webhook-delivery.md)
- [Retry a webhook delivery](https://docs.leamout.com/api-reference/webhooks/retry-a-webhook-delivery.md)
- [Self-hosting overview](https://docs.leamout.com/self-hosting/overview.md): Run the Leamout communications runtime on infrastructure you control.
- [Architecture](https://docs.leamout.com/self-hosting/architecture.md): Understand the product-level trust zones in a self-hosted Leamout runtime.
- [Requirements](https://docs.leamout.com/self-hosting/requirements.md): Supported host contract and prerequisites for the current self-hosted production target.
- [Installation](https://docs.leamout.com/self-hosting/installation.md): Initialize a staged Leamout self-hosted runtime with the operator CLI.
- [Configuration](https://docs.leamout.com/self-hosting/configuration.md): Know where Leamout stores deployment identity, secrets, runtime files, and local state.
- [Networking](https://docs.leamout.com/self-hosting/networking.md): Plan signaling, media, and private-control network boundaries.
- [DNS & TLS](https://docs.leamout.com/self-hosting/dns-tls.md): Prepare names and certificate material for SIP, WSS, TURN, and API traffic.
- [Firewall & ports](https://docs.leamout.com/self-hosting/firewall-ports.md): Understand the customer-facing ports used by the current deployment topology.
- [Licensing](https://docs.leamout.com/self-hosting/licensing.md): Verify and install signed offline licenses for a self-hosted deployment.
- [CLI](https://docs.leamout.com/self-hosting/cli.md): Use the current Leamout self-hosted operator commands.
- [Health checks](https://docs.leamout.com/self-hosting/health-checks.md): Validate the installed runtime and understand current service health probes.
- [Observability](https://docs.leamout.com/self-hosting/observability.md): Observe Leamout runtime health and telecom behavior without exposing private control interfaces.
- [Logs](https://docs.leamout.com/self-hosting/logs.md): Follow runtime logs through the Leamout operator CLI.
- [Troubleshooting](https://docs.leamout.com/self-hosting/troubleshooting.md): Diagnose common self-hosted runtime problems from the supported operator surface.
- [Upgrade](https://docs.leamout.com/self-hosting/upgrade.md): Install the runtime bundle staged for the current production CLI version.
- [Backup](https://docs.leamout.com/self-hosting/backup.md): Create a portable backup of deployment identity, configuration, license material, and durable application state.
- [Restore](https://docs.leamout.com/self-hosting/restore.md): Restore a validated backup to the same Leamout deployment identity.
- [Disaster recovery](https://docs.leamout.com/self-hosting/disaster-recovery.md): Plan recovery around durable deployment identity and the data the current backup command protects.

## OpenAPI Specs

- [openapi](/openapi.json)