# Larynth

> Documentation for Larynth, the AI phone agent that answers and makes calls for your business.

- [Larynth documentation](https://docs.larynth.com/index.md): Set up an AI phone agent that answers and makes calls for your business.
- [Quickstart](https://docs.larynth.com/quickstart.md): Create an agent, test it in your browser, and give it a phone number.
- [Agents](https://docs.larynth.com/concepts/agents.md): An agent is the instructions, voice and settings behind your phone line.
- [Phone numbers](https://docs.larynth.com/concepts/phone-numbers.md): Order a number, route it to an agent, or forward your existing number.
- [Calls](https://docs.larynth.com/concepts/calls.md): Inbound, outbound and browser calls, and what you get back for each.
- [Knowledge](https://docs.larynth.com/concepts/knowledge.md): Give an agent your business information so it answers from facts.
- [Handoff to a person](https://docs.larynth.com/concepts/handoff.md): Transfer a call to a human, warm or cold.
- [Summaries and extraction](https://docs.larynth.com/concepts/summaries.md): What Larynth writes after every call, and how to get structured data out of it.
- [Billing](https://docs.larynth.com/concepts/billing.md): How prepaid credit, per-minute pricing and phone numbers are charged.
- [Compliance](https://docs.larynth.com/concepts/compliance.md): The checks Larynth runs on outbound calls, and what stays your responsibility.
- [Recordings and data](https://docs.larynth.com/concepts/recordings-and-data.md): What is recorded, how it is protected, and how long it is kept.
- [Forward your number](https://docs.larynth.com/guides/forward-your-number.md): Keep your business number and send calls to your Larynth agent.
- [Outbound with consent](https://docs.larynth.com/guides/outbound-with-consent.md): Record consent, import contacts and run a campaign through the compliance checks.
- [Test in the browser](https://docs.larynth.com/guides/test-in-browser.md): Talk to an agent from your browser before it gets a phone number.
- [Support](https://docs.larynth.com/support.md): How to reach a person at Larynth.
- [API overview](https://docs.larynth.com/api-reference/introduction.md): The Larynth REST API. JSON over HTTPS, bearer API keys, cursor pagination and problem+json errors.
- [Authentication](https://docs.larynth.com/api-reference/authentication.md): Authenticate with a bearer API key. Each key carries scopes that limit what it can do.
- [Errors](https://docs.larynth.com/api-reference/errors.md): Errors are RFC 9457 problem+json responses with a stable code you can match on.
- [Pagination](https://docs.larynth.com/api-reference/pagination.md): List endpoints return a page of results and an opaque cursor for the next page.
- [Idempotency](https://docs.larynth.com/api-reference/idempotency.md): Send an Idempotency-Key so a retried request cannot place a second call.
- [List assistants](https://docs.larynth.com/api-reference/assistants/list-assistants.md)
- [Create an assistant](https://docs.larynth.com/api-reference/assistants/create-an-assistant.md)
- [Archive an assistant](https://docs.larynth.com/api-reference/assistants/archive-an-assistant.md)
- [Get an assistant](https://docs.larynth.com/api-reference/assistants/get-an-assistant.md)
- [Rename an assistant](https://docs.larynth.com/api-reference/assistants/rename-an-assistant.md)
- [List versions, newest first](https://docs.larynth.com/api-reference/assistants/list-versions-newest-first.md)
- [Create a draft version](https://docs.larynth.com/api-reference/assistants/create-a-draft-version.md)
- [Get a version](https://docs.larynth.com/api-reference/assistants/get-a-version.md)
- [Publish a version; it becomes immutable](https://docs.larynth.com/api-reference/assistants/publish-a-version;-it-becomes-immutable.md)
- [Start a browser (WebRTC) test call to an assistant](https://docs.larynth.com/api-reference/calls/start-a-browser-webrtc-test-call-to-an-assistant.md)
- [List calls, newest first](https://docs.larynth.com/api-reference/calls/list-calls-newest-first.md)
- [Place one outbound call through the same gates as a campaign](https://docs.larynth.com/api-reference/calls/place-one-outbound-call-through-the-same-gates-as-a-campaign.md)
- [Get a call](https://docs.larynth.com/api-reference/calls/get-a-call.md)
- [Get a call's post-call summary and extracted data](https://docs.larynth.com/api-reference/calls/get-a-calls-post-call-summary-and-extracted-data.md)
- [Hang up an active call](https://docs.larynth.com/api-reference/calls/hang-up-an-active-call.md)
- [List a call's raw events in seq order](https://docs.larynth.com/api-reference/calls/list-a-calls-raw-events-in-seq-order.md)
- [List a call's turns](https://docs.larynth.com/api-reference/calls/list-a-calls-turns.md)
- [Issue short-lived STUN/TURN servers for a browser test call](https://docs.larynth.com/api-reference/calls/issue-short-lived-stunturn-servers-for-a-browser-test-call.md)
- [List a call's recordings](https://docs.larynth.com/api-reference/recordings/list-a-calls-recordings.md)
- [Stream the decrypted WAV; audited](https://docs.larynth.com/api-reference/recordings/stream-the-decrypted-wav;-audited.md)
- [List campaigns](https://docs.larynth.com/api-reference/campaigns/list-campaigns.md)
- [Create a draft campaign](https://docs.larynth.com/api-reference/campaigns/create-a-draft-campaign.md)
- [Get a campaign](https://docs.larynth.com/api-reference/campaigns/get-a-campaign.md)
- [Update a campaign](https://docs.larynth.com/api-reference/campaigns/update-a-campaign.md)
- [Archive a campaign](https://docs.larynth.com/api-reference/campaigns/archive-a-campaign.md)
- [List a campaign's contacts and their dial state](https://docs.larynth.com/api-reference/campaigns/list-a-campaigns-contacts-and-their-dial-state.md)
- [Enrol existing contacts](https://docs.larynth.com/api-reference/campaigns/enrol-existing-contacts.md)
- [Pause dialing; active calls continue](https://docs.larynth.com/api-reference/campaigns/pause-dialing;-active-calls-continue.md)
- [Resume a paused campaign](https://docs.larynth.com/api-reference/campaigns/resume-a-paused-campaign.md)
- [Start dialing](https://docs.larynth.com/api-reference/campaigns/start-dialing.md)
- [Campaign counters](https://docs.larynth.com/api-reference/campaigns/campaign-counters.md)
- [List contacts](https://docs.larynth.com/api-reference/contacts/list-contacts.md)
- [Create a contact](https://docs.larynth.com/api-reference/contacts/create-a-contact.md)
- [Upload a CSV of contacts with a consent attestation](https://docs.larynth.com/api-reference/contacts/upload-a-csv-of-contacts-with-a-consent-attestation.md)
- [Get an import's progress](https://docs.larynth.com/api-reference/contacts/get-an-imports-progress.md)
- [Delete a contact](https://docs.larynth.com/api-reference/contacts/delete-a-contact.md)
- [Get a contact](https://docs.larynth.com/api-reference/contacts/get-a-contact.md)
- [Update a contact](https://docs.larynth.com/api-reference/contacts/update-a-contact.md)
- [List consent records](https://docs.larynth.com/api-reference/compliance/list-consent-records.md)
- [Record consent with evidence](https://docs.larynth.com/api-reference/compliance/record-consent-with-evidence.md)
- [List pre-dial decisions](https://docs.larynth.com/api-reference/compliance/list-pre-dial-decisions.md)
- [List internal do-not-call entries](https://docs.larynth.com/api-reference/compliance/list-internal-do-not-call-entries.md)
- [Add a number to the internal do-not-call list](https://docs.larynth.com/api-reference/compliance/add-a-number-to-the-internal-do-not-call-list.md)
- [Record a consent revocation; the number is added to the internal DNC](https://docs.larynth.com/api-reference/compliance/record-a-consent-revocation;-the-number-is-added-to-the-internal-dnc.md)
- [List numbers](https://docs.larynth.com/api-reference/numbers/list-numbers.md)
- [Order a number; provisioning is asynchronous](https://docs.larynth.com/api-reference/numbers/order-a-number;-provisioning-is-asynchronous.md)
- [Search numbers available to order](https://docs.larynth.com/api-reference/numbers/search-numbers-available-to-order.md)
- [Release a number; asynchronous](https://docs.larynth.com/api-reference/numbers/release-a-number;-asynchronous.md)
- [Get a number](https://docs.larynth.com/api-reference/numbers/get-a-number.md)
- [Change inbound routing](https://docs.larynth.com/api-reference/numbers/change-inbound-routing.md)
- [List knowledge bases](https://docs.larynth.com/api-reference/knowledge/list-knowledge-bases.md)
- [Create an empty knowledge base](https://docs.larynth.com/api-reference/knowledge/create-an-empty-knowledge-base.md)
- [Delete a knowledge base with its sources](https://docs.larynth.com/api-reference/knowledge/delete-a-knowledge-base-with-its-sources.md)
- [Get a knowledge base](https://docs.larynth.com/api-reference/knowledge/get-a-knowledge-base.md)
- [Rename a knowledge base](https://docs.larynth.com/api-reference/knowledge/rename-a-knowledge-base.md)
- [Run a retrieval query against a knowledge base](https://docs.larynth.com/api-reference/knowledge/run-a-retrieval-query-against-a-knowledge-base.md)
- [List the sources of a knowledge base](https://docs.larynth.com/api-reference/knowledge/list-the-sources-of-a-knowledge-base.md)
- [Upload a PDF, DOCX, TXT, MD or CSV file (up to 20 MB)](https://docs.larynth.com/api-reference/knowledge/upload-a-pdf-docx-txt-md-or-csv-file-up-to-20-mb.md)
- [Add a website source; the crawl runs in the background](https://docs.larynth.com/api-reference/knowledge/add-a-website-source;-the-crawl-runs-in-the-background.md)
- [Delete a source and rebuild the knowledge base](https://docs.larynth.com/api-reference/knowledge/delete-a-source-and-rebuild-the-knowledge-base.md)
- [Get a source and its processing status](https://docs.larynth.com/api-reference/knowledge/get-a-source-and-its-processing-status.md)
- [Re-fetch a website or re-read a file](https://docs.larynth.com/api-reference/knowledge/re-fetch-a-website-or-re-read-a-file.md)
- [Auto top-up settings](https://docs.larynth.com/api-reference/billing/auto-top-up-settings.md)
- [Prepaid balance](https://docs.larynth.com/api-reference/billing/prepaid-balance.md)
- [Ledger entries of the tenant's accounts, newest first](https://docs.larynth.com/api-reference/billing/ledger-entries-of-the-tenants-accounts-newest-first.md)
- [Rates in force](https://docs.larynth.com/api-reference/billing/rates-in-force.md)
- [List enabled models](https://docs.larynth.com/api-reference/catalog/list-enabled-models.md)
- [List enabled voices](https://docs.larynth.com/api-reference/catalog/list-enabled-voices.md)
- [List webhook endpoints](https://docs.larynth.com/api-reference/webhooks/list-webhook-endpoints.md)
- [Create a webhook endpoint; the secret is shown once](https://docs.larynth.com/api-reference/webhooks/create-a-webhook-endpoint;-the-secret-is-shown-once.md)
- [Delete a webhook endpoint](https://docs.larynth.com/api-reference/webhooks/delete-a-webhook-endpoint.md)
- [Get a webhook endpoint](https://docs.larynth.com/api-reference/webhooks/get-a-webhook-endpoint.md)
- [Update a webhook endpoint](https://docs.larynth.com/api-reference/webhooks/update-a-webhook-endpoint.md)
- [List delivery attempts, newest first](https://docs.larynth.com/api-reference/webhooks/list-delivery-attempts-newest-first.md)
- [Rotate the signing secret; the old one stays valid for 24 h](https://docs.larynth.com/api-reference/webhooks/rotate-the-signing-secret;-the-old-one-stays-valid-for-24-h.md)
- [Send a test event](https://docs.larynth.com/api-reference/webhooks/send-a-test-event.md)
- [Webhooks overview](https://docs.larynth.com/webhooks/overview.md): Receive signed HTTPS callbacks when calls end, summaries are ready, balances run low and more.
- [Event types](https://docs.larynth.com/webhooks/events.md): Every webhook event type with its payload.
- [Verify signatures](https://docs.larynth.com/webhooks/verify-signatures.md): Check that a webhook came from Larynth by recomputing its HMAC-SHA256 signature.
- [TypeScript SDK](https://docs.larynth.com/sdks/typescript.md): A typed client for the Larynth API, with a webhook signature verifier.
- [Python SDK](https://docs.larynth.com/sdks/python.md): A typed client for the Larynth API, with a webhook signature verifier.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.