# Feather

> Feather is a voice AI calling platform that allows you to build voice AI agents that can make and receive calls, send and receive SMS, and more.

## Docs

- [Create or get shareable link for an agent version](https://docs.featherhq.com/api-reference/agent-shares/create-or-get-shareable-link-for-an-agent-version.md): Generate a shareable link for a specific agent version. Returns existing link if one already exists.
- [Delete the shareable link for an agent version](https://docs.featherhq.com/api-reference/agent-shares/delete-the-shareable-link-for-an-agent-version.md): Delete the shareable link for a specific agent version
- [Dispatch a shared agent (web mode)](https://docs.featherhq.com/api-reference/agent-shares/dispatch-a-shared-agent-web-mode.md): Create a web call session using a shared agent link
- [Get shareable link for an agent version](https://docs.featherhq.com/api-reference/agent-shares/get-shareable-link-for-an-agent-version.md): Get the shareable link for a specific agent version (only one per version)
- [Update the shareable link for an agent version](https://docs.featherhq.com/api-reference/agent-shares/update-the-shareable-link-for-an-agent-version.md): Update the seconds limit for a shareable link
- [Start chat test session](https://docs.featherhq.com/api-reference/agent-test/start-chat-test-session.md): Initialize a new chat test session for an agent without making a phone call
- [Clone an existing agent](https://docs.featherhq.com/api-reference/agents/clone-an-existing-agent.md): Clone an existing agent with either the latest or deployed version
- [Create a new agent](https://docs.featherhq.com/api-reference/agents/create-a-new-agent.md): Create a new voice or text (SMS) agent
- [Create agent version](https://docs.featherhq.com/api-reference/agents/create-agent-version.md): Create a new version for an existing agent
- [Delete agent version](https://docs.featherhq.com/api-reference/agents/delete-agent-version.md): Delete a version of an agent
- [Delete an agent](https://docs.featherhq.com/api-reference/agents/delete-an-agent.md): Delete an agent
- [Deploy agent version](https://docs.featherhq.com/api-reference/agents/deploy-agent-version.md): Deploy an existing agent version
- [List agent deployments](https://docs.featherhq.com/api-reference/agents/list-agent-deployments.md): List all deployments for an agent
- [List agent versions](https://docs.featherhq.com/api-reference/agents/list-agent-versions.md): List all versions of an agent with cursor-based pagination
- [List all agents](https://docs.featherhq.com/api-reference/agents/list-all-agents.md): List all agents with cursor-based pagination
- [Update agent version](https://docs.featherhq.com/api-reference/agents/update-agent-version.md): Update an existing agent version
- [Update agent version email configuration](https://docs.featherhq.com/api-reference/agents/update-agent-version-email-configuration.md): Update the email-specific configuration for an agent version. The linked domain must be VERIFIED before it can be used.
- [Update an agent](https://docs.featherhq.com/api-reference/agents/update-an-agent.md): Update an existing agent
- [Delete bridging number](https://docs.featherhq.com/api-reference/bridging-numbers/delete-bridging-number.md)
- [Import bridging number from Twilio account](https://docs.featherhq.com/api-reference/bridging-numbers/import-bridging-number-from-twilio-account.md)
- [List organization bridging numbers](https://docs.featherhq.com/api-reference/bridging-numbers/list-organization-bridging-numbers.md)
- [Cancel a booking](https://docs.featherhq.com/api-reference/calendar-bookings/cancel-a-booking.md)
- [Create a booking](https://docs.featherhq.com/api-reference/calendar-bookings/create-a-booking.md)
- [Get a booking](https://docs.featherhq.com/api-reference/calendar-bookings/get-a-booking.md)
- [List bookings](https://docs.featherhq.com/api-reference/calendar-bookings/list-bookings.md)
- [Reschedule a booking](https://docs.featherhq.com/api-reference/calendar-bookings/reschedule-a-booking.md)
- [Delete a calendar connection](https://docs.featherhq.com/api-reference/calendar-connections/delete-a-calendar-connection.md)
- [Get OAuth URL for external calendar](https://docs.featherhq.com/api-reference/calendar-connections/get-oauth-url-for-external-calendar.md)
- [List calendar connections](https://docs.featherhq.com/api-reference/calendar-connections/list-calendar-connections.md)
- [List external calendars from a connected account](https://docs.featherhq.com/api-reference/calendar-connections/list-external-calendars-from-a-connected-account.md)
- [OAuth callback for external calendar](https://docs.featherhq.com/api-reference/calendar-connections/oauth-callback-for-external-calendar.md)
- [Update a calendar connection](https://docs.featherhq.com/api-reference/calendar-connections/update-a-calendar-connection.md)
- [Create an event type](https://docs.featherhq.com/api-reference/calendar-event-types/create-an-event-type.md)
- [Delete an event type](https://docs.featherhq.com/api-reference/calendar-event-types/delete-an-event-type.md)
- [Get an event type](https://docs.featherhq.com/api-reference/calendar-event-types/get-an-event-type.md)
- [Get available slots](https://docs.featherhq.com/api-reference/calendar-event-types/get-available-slots.md)
- [List event types](https://docs.featherhq.com/api-reference/calendar-event-types/list-event-types.md)
- [Update an event type](https://docs.featherhq.com/api-reference/calendar-event-types/update-an-event-type.md)
- [Create a schedule](https://docs.featherhq.com/api-reference/calendar-schedules/create-a-schedule.md)
- [Delete a schedule](https://docs.featherhq.com/api-reference/calendar-schedules/delete-a-schedule.md)
- [Get a schedule](https://docs.featherhq.com/api-reference/calendar-schedules/get-a-schedule.md)
- [List schedules](https://docs.featherhq.com/api-reference/calendar-schedules/list-schedules.md)
- [Update a schedule](https://docs.featherhq.com/api-reference/calendar-schedules/update-a-schedule.md)
- [Create a calendar](https://docs.featherhq.com/api-reference/calendars/create-a-calendar.md)
- [Delete a calendar](https://docs.featherhq.com/api-reference/calendars/delete-a-calendar.md)
- [Get a calendar](https://docs.featherhq.com/api-reference/calendars/get-a-calendar.md)
- [List calendars](https://docs.featherhq.com/api-reference/calendars/list-calendars.md)
- [Update a calendar](https://docs.featherhq.com/api-reference/calendars/update-a-calendar.md)
- [Get call record](https://docs.featherhq.com/api-reference/calls/get-call-record.md): Get an agent call by ID
- [List all calls](https://docs.featherhq.com/api-reference/calls/list-all-calls.md): List agent calls with cursor-based pagination
- [Create a new web chat thread](https://docs.featherhq.com/api-reference/chat/create-a-new-web-chat-thread.md): Create a new chat thread for web-based conversations. Returns thread ID and authentication token.
- [Get available voices](https://docs.featherhq.com/api-reference/configuration/get-available-voices.md): Get all available voices
- [Get LLM configs](https://docs.featherhq.com/api-reference/configuration/get-llm-configs.md): Get all available LLM configurations
- [Get STT configs](https://docs.featherhq.com/api-reference/configuration/get-stt-configs.md): Get all available STT configurations
- [Get supported languages](https://docs.featherhq.com/api-reference/configuration/get-supported-languages.md): Get all active supported languages
- [Get TTS configs](https://docs.featherhq.com/api-reference/configuration/get-tts-configs.md): Get all available TTS configurations
- [Disconnect explicit dispatch](https://docs.featherhq.com/api-reference/dispatch/disconnect-explicit-dispatch.md)
- [Dispatch audio agent](https://docs.featherhq.com/api-reference/dispatch/dispatch-audio-agent.md): Create a new explicit dispatch for a specific agent
- [Listen to audio agent](https://docs.featherhq.com/api-reference/dispatch/listen-to-audio-agent.md): Create a listener token to join an existing agent call room
- [Add phone number to DNC list](https://docs.featherhq.com/api-reference/dnc/add-phone-number-to-dnc-list.md): Add a phone number to the Do Not Call block list
- [Check if phone number is on DNC list](https://docs.featherhq.com/api-reference/dnc/check-if-phone-number-is-on-dnc-list.md): Check if a phone number is on the DNC block list (URL encoded, e.g., %2B14155551234)
- [Delete DNC entry by ID](https://docs.featherhq.com/api-reference/dnc/delete-dnc-entry-by-id.md): Remove a phone number from the DNC block list by entry ID
- [Delete DNC entry by phone number](https://docs.featherhq.com/api-reference/dnc/delete-dnc-entry-by-phone-number.md): Remove a phone number from the DNC block list by phone number (URL encoded, e.g., %2B14155551234)
- [Get DNC entry by ID](https://docs.featherhq.com/api-reference/dnc/get-dnc-entry-by-id.md): Get a DNC entry by its ID
- [Get DNC entry by phone number](https://docs.featherhq.com/api-reference/dnc/get-dnc-entry-by-phone-number.md): Get a DNC entry by phone number (URL encoded, e.g., %2B14155551234)
- [List DNC entries](https://docs.featherhq.com/api-reference/dnc/list-dnc-entries.md): List all DNC entries with cursor-based pagination
- [Create an email domain](https://docs.featherhq.com/api-reference/email-domains/create-an-email-domain.md): Register a new subdomain with Resend and return the DNS records the customer must add to their DNS provider.
- [Delete an email domain](https://docs.featherhq.com/api-reference/email-domains/delete-an-email-domain.md): Delete an email domain. Fails if any agent version is currently using this domain.
- [Get an email domain](https://docs.featherhq.com/api-reference/email-domains/get-an-email-domain.md): Retrieve a single email domain by ID
- [List email domains](https://docs.featherhq.com/api-reference/email-domains/list-email-domains.md): List all email domains for the organization
- [Verify an email domain](https://docs.featherhq.com/api-reference/email-domains/verify-an-email-domain.md): Trigger Resend domain verification and update per-record verification state. Returns the updated domain with mxVerified, spfVerified, dkimVerified, cnameVerified flags.
- [Create an email thread](https://docs.featherhq.com/api-reference/email/create-an-email-thread.md): Initialize an outbound email thread for the given agent version. The version must be deployed and have a verified email domain configured.
- [Get messages for an email thread](https://docs.featherhq.com/api-reference/email/get-messages-for-an-email-thread.md): Get messages for a specific email thread with cursor-based pagination
- [List email threads](https://docs.featherhq.com/api-reference/email/list-email-threads.md): List email threads with cursor-based pagination and optional filters
- [Health check](https://docs.featherhq.com/api-reference/health/health-check.md)
- [Create an integration instance](https://docs.featherhq.com/api-reference/integrations/create-an-integration-instance.md): Create a new integration instance for the organization
- [Delete an integration instance](https://docs.featherhq.com/api-reference/integrations/delete-an-integration-instance.md): Delete an integration instance for the organization
- [List all available integrations](https://docs.featherhq.com/api-reference/integrations/list-all-available-integrations.md): List all available integrations in the platform
- [List integration instances for organization](https://docs.featherhq.com/api-reference/integrations/list-integration-instances-for-organization.md): List all integration instances configured for the organization
- [Update an integration instance](https://docs.featherhq.com/api-reference/integrations/update-an-integration-instance.md): Update an integration instance for the organization
- [Add file to collection](https://docs.featherhq.com/api-reference/knowledge-base/add-file-to-collection.md)
- [Create knowledge base collection](https://docs.featherhq.com/api-reference/knowledge-base/create-knowledge-base-collection.md)
- [Create knowledge base file](https://docs.featherhq.com/api-reference/knowledge-base/create-knowledge-base-file.md)
- [Delete knowledge base collection](https://docs.featherhq.com/api-reference/knowledge-base/delete-knowledge-base-collection.md)
- [Delete knowledge base file](https://docs.featherhq.com/api-reference/knowledge-base/delete-knowledge-base-file.md)
- [Generate presigned URL for uploading a file](https://docs.featherhq.com/api-reference/knowledge-base/generate-presigned-url-for-uploading-a-file.md): Generate a pre-signed URL for uploading a file to S3
- [Get knowledge base collections](https://docs.featherhq.com/api-reference/knowledge-base/get-knowledge-base-collections.md)
- [Get knowledge base files](https://docs.featherhq.com/api-reference/knowledge-base/get-knowledge-base-files.md)
- [Remove file from collection](https://docs.featherhq.com/api-reference/knowledge-base/remove-file-from-collection.md)
- [Update file status](https://docs.featherhq.com/api-reference/knowledge-base/update-file-status.md)
- [View knowledge base file](https://docs.featherhq.com/api-reference/knowledge-base/view-knowledge-base-file.md)
- [Get current organization](https://docs.featherhq.com/api-reference/organization/get-current-organization.md)
- [Update organization settings](https://docs.featherhq.com/api-reference/organization/update-organization-settings.md)
- [Connect Twilio account](https://docs.featherhq.com/api-reference/phone-numbers/connect-twilio-account.md)
- [Create inbound dispatch rule](https://docs.featherhq.com/api-reference/phone-numbers/create-inbound-dispatch-rule.md)
- [Delete phone number](https://docs.featherhq.com/api-reference/phone-numbers/delete-phone-number.md)
- [Get phone number by E.164 format](https://docs.featherhq.com/api-reference/phone-numbers/get-phone-number-by-e-164-format.md): Get a phone number record by E.164 phone number (URL encoded, e.g., %2B14155551234)
- [Link SMS agent to phone number](https://docs.featherhq.com/api-reference/phone-numbers/link-sms-agent-to-phone-number.md): Link an SMS agent to a phone number for SMS conversations. Only one SMS agent can be linked to a phone number at a time.
- [List organization phone numbers](https://docs.featherhq.com/api-reference/phone-numbers/list-organization-phone-numbers.md)
- [Purchase a Twilio phone number](https://docs.featherhq.com/api-reference/phone-numbers/purchase-a-twilio-phone-number.md): Purchase a phone number from Twilio and add it to the organization. Requires sufficient phone_lines credits.
- [Remove inbound dispatch rule](https://docs.featherhq.com/api-reference/phone-numbers/remove-inbound-dispatch-rule.md)
- [Search available Twilio phone numbers](https://docs.featherhq.com/api-reference/phone-numbers/search-available-twilio-phone-numbers.md): Search for available phone numbers from Twilio based on various criteria
- [Unlink SMS agent from phone number](https://docs.featherhq.com/api-reference/phone-numbers/unlink-sms-agent-from-phone-number.md): Remove the SMS agent link from a phone number
- [Update outbound dispatch rules with bulk agent IDs](https://docs.featherhq.com/api-reference/phone-numbers/update-outbound-dispatch-rules-with-bulk-agent-ids.md)
- [List all prompt personalities](https://docs.featherhq.com/api-reference/prompts/list-all-prompt-personalities.md): List all available prompt personalities
- [Create a new report generation job](https://docs.featherhq.com/api-reference/reports/create-a-new-report-generation-job.md): Creates a new report generation job for exporting AgentCalls data. The report is generated asynchronously.
- [Get download URL for a report](https://docs.featherhq.com/api-reference/reports/get-download-url-for-a-report.md): Get a presigned URL to download a completed report
- [List generated reports](https://docs.featherhq.com/api-reference/reports/list-generated-reports.md): List all reports for the organization with cursor-based pagination
- [Close an SMS thread](https://docs.featherhq.com/api-reference/sms-threads/close-an-sms-thread.md): Close an active SMS thread
- [Create a new SMS thread](https://docs.featherhq.com/api-reference/sms-threads/create-a-new-sms-thread.md): Create a new SMS thread for text-based conversations
- [Get an SMS thread by ID](https://docs.featherhq.com/api-reference/sms-threads/get-an-sms-thread-by-id.md): Get details of a specific SMS thread
- [Get messages for an SMS thread](https://docs.featherhq.com/api-reference/sms-threads/get-messages-for-an-sms-thread.md): Get messages for a specific SMS thread with cursor-based pagination
- [List SMS threads](https://docs.featherhq.com/api-reference/sms-threads/list-sms-threads.md): List SMS threads with cursor-based pagination and optional filters
- [Create a new squad](https://docs.featherhq.com/api-reference/squad/create-a-new-squad.md): Create a new squad configuration with an entrypoint agent
- [Create transfer rule](https://docs.featherhq.com/api-reference/squad/create-transfer-rule.md): Create a new transfer rule between two agents in a squad
- [Delete squad](https://docs.featherhq.com/api-reference/squad/delete-squad.md): Soft delete squad by setting archived=true
- [Delete transfer rule](https://docs.featherhq.com/api-reference/squad/delete-transfer-rule.md): Hard delete a transfer rule
- [Dispatch squad](https://docs.featherhq.com/api-reference/squad/dispatch-squad.md): Create a new dispatch for a squad, resolving the entrypoint agent internally
- [Get squad details](https://docs.featherhq.com/api-reference/squad/get-squad-details.md): Get detailed squad configuration including entrypoint agent, transfer rules, phone numbers, member agents, and basic stats
- [List all squads for an organization](https://docs.featherhq.com/api-reference/squad/list-all-squads-for-an-organization.md): Get a paginated list of squads with transfer rule counts
- [List transfer rules](https://docs.featherhq.com/api-reference/squad/list-transfer-rules.md): Get all transfer rules for a squad with optional filters
- [Update squad](https://docs.featherhq.com/api-reference/squad/update-squad.md): Update squad name, description, entrypoint agent, or archived status
- [Update transfer rule](https://docs.featherhq.com/api-reference/squad/update-transfer-rule.md): Update an existing transfer rule
- [Delete testing lab scenario by ID](https://docs.featherhq.com/api-reference/testing-lab/delete-testing-lab-scenario-by-id.md)
- [Generate testing lab scenarios](https://docs.featherhq.com/api-reference/testing-lab/generate-testing-lab-scenarios.md)
- [Get testing lab scenario by ID](https://docs.featherhq.com/api-reference/testing-lab/get-testing-lab-scenario-by-id.md)
- [Get testing lab scenarios](https://docs.featherhq.com/api-reference/testing-lab/get-testing-lab-scenarios.md)
- [Run testing lab scenarios](https://docs.featherhq.com/api-reference/testing-lab/run-testing-lab-scenarios.md)
- [Update testing lab scenario by ID](https://docs.featherhq.com/api-reference/testing-lab/update-testing-lab-scenario-by-id.md)
- [Create new tool](https://docs.featherhq.com/api-reference/tools/create-new-tool.md): Create a new tool
- [Delete tool](https://docs.featherhq.com/api-reference/tools/delete-tool.md): Delete a tool by ID
- [Get tool details](https://docs.featherhq.com/api-reference/tools/get-tool-details.md): Get a tool by ID
- [List custom tools](https://docs.featherhq.com/api-reference/tools/list-custom-tools.md): List all tools with cursor-based pagination
- [List pre-built tools](https://docs.featherhq.com/api-reference/tools/list-pre-built-tools.md): List all pre-built tools
- [Update tool](https://docs.featherhq.com/api-reference/tools/update-tool.md): Update an existing tool
- [Bulk create workflow executions](https://docs.featherhq.com/api-reference/workflows/bulk-create-workflow-executions.md): Create multiple agent workflow executions at once (max 25 leads)
- [Cancel all workflow executions by phone number](https://docs.featherhq.com/api-reference/workflows/cancel-all-workflow-executions-by-phone-number.md): Cancel all running agent workflow executions across all workflows for a given phone number. Returns the count of cancelled executions.
- [Cancel workflow execution](https://docs.featherhq.com/api-reference/workflows/cancel-workflow-execution.md): Cancel an agent workflow execution
- [Cancel workflow execution by lead ID](https://docs.featherhq.com/api-reference/workflows/cancel-workflow-execution-by-lead-id.md): Cancel an agent workflow execution using the customer lead ID
- [Cancel workflow executions by phone number](https://docs.featherhq.com/api-reference/workflows/cancel-workflow-executions-by-phone-number.md): Cancel all running agent workflow executions for a given phone number. Returns the count of cancelled executions.
- [Create agent workflow](https://docs.featherhq.com/api-reference/workflows/create-agent-workflow.md): Create a new agent workflow
- [Create workflow execution](https://docs.featherhq.com/api-reference/workflows/create-workflow-execution.md): Create a new agent workflow execution
- [Delete agent workflow](https://docs.featherhq.com/api-reference/workflows/delete-agent-workflow.md): Delete an agent workflow
- [Delete workflow execution](https://docs.featherhq.com/api-reference/workflows/delete-workflow-execution.md): Delete an agent workflow execution
- [Get agent workflow](https://docs.featherhq.com/api-reference/workflows/get-agent-workflow.md): Get an agent workflow by ID
- [Get workflow execution](https://docs.featherhq.com/api-reference/workflows/get-workflow-execution.md): Get an agent workflow execution by ID
- [List agent workflows](https://docs.featherhq.com/api-reference/workflows/list-agent-workflows.md): List agent workflows
- [List workflow executions](https://docs.featherhq.com/api-reference/workflows/list-workflow-executions.md): List agent workflow executions
- [Pause workflow execution](https://docs.featherhq.com/api-reference/workflows/pause-workflow-execution.md): Pause an agent workflow execution
- [Resume workflow execution](https://docs.featherhq.com/api-reference/workflows/resume-workflow-execution.md): Resume an agent workflow execution
- [Update agent workflow](https://docs.featherhq.com/api-reference/workflows/update-agent-workflow.md): Update an agent workflow
- [Update workflow execution](https://docs.featherhq.com/api-reference/workflows/update-workflow-execution.md): Update an agent workflow execution
- [Agents](https://docs.featherhq.com/documentation/core-concepts/agents.md): Agents are Feather's reusable conversation workers. Versions define behavior, models, prompts, tools, and channel-specific settings.
- [Calendars](https://docs.featherhq.com/documentation/core-concepts/calendars.md): Calendars, schedules, event types, bookings, and external connections give Feather agents a native scheduling layer.
- [Conversations](https://docs.featherhq.com/documentation/core-concepts/calls.md): Feather supports voice calls, SMS threads, email threads, and web chat using a shared conversation model.
- [Configurations](https://docs.featherhq.com/documentation/core-concepts/configurations.md): Configure the listening, reasoning, speaking, and messaging behavior that each Feather agent version uses.
- [Integrations](https://docs.featherhq.com/documentation/core-concepts/integrations.md): Integrations connect Feather to external systems so agents can use authenticated, reusable business capabilities.
- [Knowledge Base](https://docs.featherhq.com/documentation/core-concepts/knowledge-base.md): Knowledge base collections let Feather agents answer from your documents instead of relying only on prompt instructions.
- [Phone Numbers](https://docs.featherhq.com/documentation/core-concepts/phone-numbers.md): Phone numbers connect Feather agents to voice and SMS channels for inbound traffic, outbound calls, and thread-based messaging.
- [Squads](https://docs.featherhq.com/documentation/core-concepts/squads.md): Squads let you route a single live call across multiple specialized voice agents.
- [Testing Lab](https://docs.featherhq.com/documentation/core-concepts/testing-lab.md): Testing Lab helps you generate scenarios, run repeatable evaluations, and compare agent behavior before deployment.
- [Tools](https://docs.featherhq.com/documentation/core-concepts/tools.md): Tools let Feather agents read data and take actions in your own systems or connected services.
- [Workflows](https://docs.featherhq.com/documentation/core-concepts/workflows.md): Workflows automate multi-step call and text outreach with reusable definitions, schedules, and per-contact executions.
- [Authentication](https://docs.featherhq.com/documentation/getting-started/authentication.md): Authenticate Feather API requests with an organization API key.
- [Introduction](https://docs.featherhq.com/documentation/getting-started/overview.md): Feather is an AI conversation platform for voice calls, SMS, email, web chat, routing, scheduling, and workflow automation.
- [Quickstart](https://docs.featherhq.com/documentation/getting-started/quickstart.md): Create a call agent, deploy it, and place a live test conversation.
- [Updating a Knowledge File](https://docs.featherhq.com/documentation/guides/updating-knowledge-base.md): Use this workflow to replace stale knowledge content, validate the new file, and roll it into the right collection safely.

## OpenAPI Specs

- [openapi](https://docs.featherhq.com/openapi.json)