# Althea Docs

## Docs

- [Agent api](https://docs.altheahealth.io/agents/agent-api.md)
- [Agent types](https://docs.altheahealth.io/agents/agent-types.md)
- [Building custom agents](https://docs.altheahealth.io/agents/building-custom-agents.md)
- [Overview](https://docs.altheahealth.io/agents/overview.md)
- [Get Account](https://docs.altheahealth.io/api-reference/accounts/accounts-me-get.md): Returns account details for a single account
- [Set Telephony Credentials](https://docs.altheahealth.io/api-reference/accounts/accounts-me-telephony-config-partial-update.md): Allows adding or updating telephony provider credentials to an account
- [Get Telephony Credentials](https://docs.altheahealth.io/api-reference/accounts/accounts-me-telephony-config-retrieve.md): Returns the telephony credentials associated with the active account
- [Set TTS API keys](https://docs.altheahealth.io/api-reference/accounts/accounts-me-tts-api-keys-partial-update.md): Allows adding or updating TTS provider API keys to an account, enabling ExternalVoices
- [Get Account TTS API Keys](https://docs.altheahealth.io/api-reference/accounts/accounts-me-tts-api-keys-retrieve.md): Returns the TTS provider API keys associated with the active account
- [Get Call Usage](https://docs.altheahealth.io/api-reference/accounts/accounts-me-usage-calls-get.md): Returns aggregated and per-day call usage data
- [List Agent Calls](https://docs.altheahealth.io/api-reference/agents/agents-calls-list.md): Lists all calls that were created using the specified agent
- [Create Agent Call](https://docs.altheahealth.io/api-reference/agents/agents-calls-post.md): Creates a new call using the the specified agent
- [Delete Agent](https://docs.altheahealth.io/api-reference/agents/agents-delete.md): Deletes the specified agent
- [Get Agent](https://docs.altheahealth.io/api-reference/agents/agents-get.md): Gets details for the specified agent
- [List Agents](https://docs.altheahealth.io/api-reference/agents/agents-list.md): Returns details for all agents
- [Update Agent](https://docs.altheahealth.io/api-reference/agents/agents-patch.md): Updates the specified agent
- [Create Agent](https://docs.altheahealth.io/api-reference/agents/agents-post.md): Creates a new agent using the specified name and call template
- [List Scheduled Call Batch Created Calls](https://docs.altheahealth.io/api-reference/agents/agents-scheduled-batches-created-calls-list.md): Returns details for all created calls in a scheduled call batch
- [Delete Scheduled Call Batch](https://docs.altheahealth.io/api-reference/agents/agents-scheduled-batches-delete.md): Deletes a scheduled call batch
- [Get Scheduled Call Batch](https://docs.altheahealth.io/api-reference/agents/agents-scheduled-batches-get.md): Returns details for a scheduled call batch
- [List Scheduled Call Batches](https://docs.altheahealth.io/api-reference/agents/agents-scheduled-batches-list.md): Returns details for all an agent's scheduled call batches
- [Update Scheduled Call Batch](https://docs.altheahealth.io/api-reference/agents/agents-scheduled-batches-patch.md): Updates a scheduled call batch
- [Create Scheduled Call Batch](https://docs.altheahealth.io/api-reference/agents/agents-scheduled-batches-post.md): Creates a new scheduled call batch using the the specified agent
- [List Scheduled Call Batch Scheduled Calls](https://docs.altheahealth.io/api-reference/agents/agents-scheduled-batches-scheduled-calls-list.md): Returns details for all scheduled calls in a scheduled call batch
- [Delete Call](https://docs.altheahealth.io/api-reference/calls/calls-delete.md): Deletes the specified call
- [Get Deleted Call](https://docs.altheahealth.io/api-reference/calls/calls-deleted-calls-get.md): Gets details for the specified deleted call
- [List Deleted Calls](https://docs.altheahealth.io/api-reference/calls/calls-deleted-calls-list.md): Returns details for all deleted calls
- [List Call Events](https://docs.altheahealth.io/api-reference/calls/calls-events-list.md): Returns any events logged during the call
- [Get Call](https://docs.altheahealth.io/api-reference/calls/calls-get.md): Gets details for the specified call
- [List Calls](https://docs.altheahealth.io/api-reference/calls/calls-list.md): Returns details for all calls
- [List Call Messages](https://docs.altheahealth.io/api-reference/calls/calls-messages-list.md): Returns all messages generated during the given call
- [Create Call](https://docs.altheahealth.io/api-reference/calls/calls-post.md): Creates a new call using the specified system prompt and other properties
- [Get Call Recording](https://docs.altheahealth.io/api-reference/calls/calls-recording-get.md): Returns a link to the recording of the call
- [Send Data Message to Call](https://docs.altheahealth.io/api-reference/calls/calls-send-data-message-post.md): Sends a data message to a live call
- [Get Sip Logs for a call](https://docs.altheahealth.io/api-reference/calls/calls-sip-logs-get.md): Redirects to the SIP logs for a call, if available. This is only available for calls with sip medium and only after the call has ended.
- [Get Call Stage](https://docs.altheahealth.io/api-reference/calls/calls-stages-get.md): Retrieves details for a specific stage of a call
- [List Call Stages](https://docs.altheahealth.io/api-reference/calls/calls-stages-list.md): Lists all stages that occurred during the specified call
- [Get Call Stage Message Audio](https://docs.altheahealth.io/api-reference/calls/calls-stages-message-audio-get.md): Gets the audio for the specified message
- [List Call Stage Messages](https://docs.altheahealth.io/api-reference/calls/calls-stages-messages-list.md): Returns all messages that were exchanged during a specific stage of a call
- [List Call Stage Tools](https://docs.altheahealth.io/api-reference/calls/calls-stages-tools-list.md): Returns all tools that were available during a specific stage of a call
- [List Call Tools](https://docs.altheahealth.io/api-reference/calls/calls-tools-list.md): Returns all tools that were available at any point during the call
- [Calls Overview](https://docs.altheahealth.io/api-reference/calls/overview.md): Understanding Calls in Althea
- [Delete Corpus](https://docs.altheahealth.io/api-reference/corpora/corpora-delete.md): Deletes the specified corpus
- [Get Corpus](https://docs.altheahealth.io/api-reference/corpora/corpora-get.md): Gets details for the specified corpus
- [List Corpora](https://docs.altheahealth.io/api-reference/corpora/corpora-list.md): Returns details for all corpora
- [Update Corpus](https://docs.altheahealth.io/api-reference/corpora/corpora-patch.md): Updates the specified corpus
- [Create Corpus](https://docs.altheahealth.io/api-reference/corpora/corpora-post.md): Creates a new corpus using the specified name and description
- [Delete Corpus Source](https://docs.altheahealth.io/api-reference/corpora/corpora-sources-delete.md): Deletes the specified source
- [Get Corpus Source Document](https://docs.altheahealth.io/api-reference/corpora/corpora-sources-documents-get.md): Retrieves details for the specified source document
- [List Corpus Source Documents](https://docs.altheahealth.io/api-reference/corpora/corpora-sources-documents-list.md): Returns details for all documents contained in the source
- [Get Corpus Source](https://docs.altheahealth.io/api-reference/corpora/corpora-sources-get.md): Retrieves details for the specified source
- [List Corpus Sources](https://docs.altheahealth.io/api-reference/corpora/corpora-sources-list.md): Lists all sources that are part of the specified corpus
- [Update Corpus Source](https://docs.altheahealth.io/api-reference/corpora/corpora-sources-patch.md): Updates the specified source
- [Create Corpus Source](https://docs.altheahealth.io/api-reference/corpora/corpora-sources-post.md): Creates a new source for the specified corpus
- [Create Corpus File Upload](https://docs.altheahealth.io/api-reference/corpora/corpora-uploads-post.md): Creates a new URL and document ID to use for uploading a static file
- [Query Corpus](https://docs.altheahealth.io/api-reference/corpora/corpus-query.md): Queries the specified corpus and returns the specified number of results
- [Corpus Service (RAG) Overview](https://docs.altheahealth.io/api-reference/corpora/overview.md): Understanding Retrieval Augmented Generation in Althea
- [Althea REST API Overview](https://docs.altheahealth.io/api-reference/introduction.md)
- [List Models](https://docs.altheahealth.io/api-reference/other/models-get.md): Retrieves the list of all available models that can be used for inference
- [Get OpenAPI Schema](https://docs.altheahealth.io/api-reference/other/schema-get.md): Gets the OpenAPI schema for the Althea REST API
- [Base Tool Definition](https://docs.altheahealth.io/api-reference/schema/base-tool-definition.md)
- [Call Definition](https://docs.altheahealth.io/api-reference/schema/call-definition.md)
- [Althea Data Message Protocol](https://docs.altheahealth.io/api-reference/schema/datamessages.md): Protocol documentation for messages exchanged between client and server during Althea calls.
- [Get Account SIP configuration](https://docs.altheahealth.io/api-reference/sip/sip-get.md): Returns the SIP configuration for your account
- [Update Account SIP configuration](https://docs.altheahealth.io/api-reference/sip/sip-partial-update.md): Allows updating your account's SIP configuration
- [Create SIP Registration](https://docs.altheahealth.io/api-reference/sip/sip-registrations-create.md): Creates a new SIP registration using the given properties
- [Delete SIP Registration](https://docs.altheahealth.io/api-reference/sip/sip-registrations-delete.md): Deletes the specified registration
- [Get SIP Registration](https://docs.altheahealth.io/api-reference/sip/sip-registrations-get.md): Gets details for the specified registration
- [List SIP Registrations](https://docs.altheahealth.io/api-reference/sip/sip-registrations-list.md): Lists SIP registrations for your account
- [Update SIP Registration](https://docs.altheahealth.io/api-reference/sip/sip-registrations-partial-update.md): Updates an existing registration
- [Delete Tool](https://docs.altheahealth.io/api-reference/tools/tools-delete.md): Deletes the specified tool
- [Get Tool](https://docs.altheahealth.io/api-reference/tools/tools-get.md): Gets details for the specified tool
- [Get Tool History](https://docs.altheahealth.io/api-reference/tools/tools-history-get.md): Gets all calls that have used the specified tool
- [List Tools](https://docs.altheahealth.io/api-reference/tools/tools-list.md): Retrieves all available tools
- [Create Tool](https://docs.altheahealth.io/api-reference/tools/tools-post.md): Creates a new tool
- [Update Tool](https://docs.altheahealth.io/api-reference/tools/tools-put.md): Replaces an existing tool
- [Test Tool](https://docs.altheahealth.io/api-reference/tools/tools-test-post.md): Tests a tool by executing it with the provided parameters
- [Preview Voice](https://docs.altheahealth.io/api-reference/voices/voice-preview-post.md): Performs a test generation of a voice, returning the resulting audio or error.
- [Delete Voice](https://docs.altheahealth.io/api-reference/voices/voices-delete.md): Deletes the specified voice
- [Get Voice](https://docs.altheahealth.io/api-reference/voices/voices-get.md): Gets details for the specified voice
- [List Voices](https://docs.altheahealth.io/api-reference/voices/voices-list.md): Retrieves all available voices
- [Update Voice](https://docs.altheahealth.io/api-reference/voices/voices-patch.md): Updates the specified voice
- [Create (Clone) Voice](https://docs.altheahealth.io/api-reference/voices/voices-post.md): Create a new cloned voice
- [Get Voice Sample](https://docs.altheahealth.io/api-reference/voices/voices-preview-get.md): Provides an audio sample for a voice, or the error caused by using it.
- [Replace Voice](https://docs.altheahealth.io/api-reference/voices/voices-put.md): Replaces the specified voice
- [Delete Webhook](https://docs.altheahealth.io/api-reference/webhooks/webhooks-delete.md): Deletes the specified webhook configuration
- [Get Webhook](https://docs.altheahealth.io/api-reference/webhooks/webhooks-get.md): Gets details for the specified webhook configuration
- [List Webhooks](https://docs.altheahealth.io/api-reference/webhooks/webhooks-list.md): Retrieves all webhooks configured on an account
- [Update Webhook](https://docs.altheahealth.io/api-reference/webhooks/webhooks-patch.md): Updates the specified webhook configuration
- [Create Webhook](https://docs.altheahealth.io/api-reference/webhooks/webhooks-post.md): Creates a new webhook configuration for an account
- [Replace Webhook](https://docs.altheahealth.io/api-reference/webhooks/webhooks-put.md): Replaces the specified webhook configuration
- [Agent boilerplates](https://docs.altheahealth.io/examples/agent-boilerplates.md)
- [Real world use cases](https://docs.altheahealth.io/examples/real-world-use-cases.md)
- [Tool templates](https://docs.altheahealth.io/examples/tool-templates.md)
- [Workflow samples](https://docs.altheahealth.io/examples/workflow-samples.md)
- [Authentication](https://docs.altheahealth.io/getting-started/authentication.md)
- [Concepts](https://docs.altheahealth.io/getting-started/concepts.md)
- [Introduction](https://docs.altheahealth.io/getting-started/introduction.md)
- [Quickstart](https://docs.altheahealth.io/getting-started/quickstart.md)
- [Async events](https://docs.altheahealth.io/guides/async-events.md)
- [Build a prior auth workflow](https://docs.altheahealth.io/guides/build-a-prior-auth-workflow.md)
- [Build a scheduling automation](https://docs.altheahealth.io/guides/build-a-scheduling-automation.md)
- [Build your first agent](https://docs.altheahealth.io/guides/build-your-first-agent.md)
- [Voice agent setup](https://docs.altheahealth.io/guides/voice-agent-setup.md)
- [Hubspot](https://docs.altheahealth.io/integrations/crm/hubspot.md)
- [Salesforce](https://docs.altheahealth.io/integrations/crm/salesforce.md)
- [Epic](https://docs.altheahealth.io/integrations/ehr/epic.md)
- [Medinformatix](https://docs.altheahealth.io/integrations/ehr/medinformatix.md)
- [Amazon connect](https://docs.altheahealth.io/integrations/telephony/amazon-connect.md)
- [Nice incontact](https://docs.altheahealth.io/integrations/telephony/nice-incontact.md)
- [Webex](https://docs.altheahealth.io/integrations/telephony/webex.md)
- [Best practices](https://docs.altheahealth.io/prompts/best-practices.md)
- [Debugging](https://docs.altheahealth.io/prompts/debugging.md)
- [Guardrails](https://docs.altheahealth.io/prompts/guardrails.md)
- [Overview](https://docs.altheahealth.io/prompts/overview.md)
- [Patterns](https://docs.altheahealth.io/prompts/patterns.md)
- [System prompts](https://docs.altheahealth.io/prompts/system-prompts.md)
- [2025 01](https://docs.altheahealth.io/release-notes/2025-01.md)
- [2025 02](https://docs.altheahealth.io/release-notes/2025-02.md)
- [2025 03](https://docs.altheahealth.io/release-notes/2025-03.md)
- [Overview](https://docs.altheahealth.io/release-notes/overview.md)
- [Althea Client SDK](https://docs.altheahealth.io/sdk-reference/introduction.md)
- [Built in tools](https://docs.altheahealth.io/tools/built-in-tools.md)
- [Creating tools](https://docs.altheahealth.io/tools/creating-tools.md)
- [Examples](https://docs.altheahealth.io/tools/examples.md)
- [Overview](https://docs.altheahealth.io/tools/overview.md)
- [Tool schema](https://docs.altheahealth.io/tools/tool-schema.md)
- [Agent settings](https://docs.altheahealth.io/voice/agent-settings.md)
- [Call analytics](https://docs.altheahealth.io/voice/call-analytics.md)
- [Call authentication](https://docs.altheahealth.io/voice/call-authentication.md)
- [Call flows](https://docs.altheahealth.io/voice/call-flows.md)
- [Call history](https://docs.altheahealth.io/voice/call-history.md)
- [Call reporting](https://docs.altheahealth.io/voice/call-reporting.md)
- [Campaign](https://docs.altheahealth.io/voice/campaign.md)
- [Campaign analytics](https://docs.altheahealth.io/voice/campaign-analytics.md)
- [Campaign history](https://docs.altheahealth.io/voice/campaign-history.md)
- [Campaign schedule](https://docs.altheahealth.io/voice/campaign-schedule.md)
- [Campaign schedule event based](https://docs.altheahealth.io/voice/campaign-schedule-event-based.md)
- [Campaign schedule time window](https://docs.altheahealth.io/voice/campaign-schedule-time-window.md)
- [Cohorts](https://docs.altheahealth.io/voice/cohorts.md)
- [Inbound calls](https://docs.altheahealth.io/voice/inbound-calls.md)
- [Outbound calls](https://docs.altheahealth.io/voice/outbound-calls.md)
- [Overview](https://docs.altheahealth.io/voice/overview.md)
- [Prompting](https://docs.altheahealth.io/voice/prompting.md)

## OpenAPI Specs

- [reference](https://docs.altheahealth.io/api/reference.yaml)
- [openapi](https://docs.altheahealth.io/api-reference1/openapi.json)