# Flireo AI

## Docs
- Root > Get started [Quickstart](https://reference.flireo.com/quickstart.md): 
- Root > Get started [Introduction](https://reference.flireo.com/quickstart/introduction.md): 
- Root > Get started [Authentication](https://reference.flireo.com/quickstart/authentication.md): 
- Root > Core concepts [Agents](https://reference.flireo.com/agents-1861370m0.md): 
- Root > Core concepts [Phone numbers](https://reference.flireo.com/phone-numbers-1861371m0.md): 
- Root > Core concepts [Calls](https://reference.flireo.com/calls-1861372m0.md): 
- Root > Core concepts [Webhooks](https://reference.flireo.com/webhooks-1861373m0.md): 
- Root > Api's [Organization](https://reference.flireo.com/organization-1861374m0.md): 
- Root > Api's [Agents](https://reference.flireo.com/agents-1861375m0.md): 
- Root > Api's [Phone numbers](https://reference.flireo.com/phone-numbers-1861376m0.md): 
- Root > Api's [Sip trunks](https://reference.flireo.com/sip-trunks-1861377m0.md): 
- Root > Api's [Calls](https://reference.flireo.com/calls-1861378m0.md): 
- Root > Api's [Call control](https://reference.flireo.com/call-control-1861381m0.md): 
- Root > Api's [Usage](https://reference.flireo.com/usage-1861382m0.md): 
- Root > Api's [Voices](https://reference.flireo.com/voices-1861383m0.md): 
- Root > Api's [BYOK](https://reference.flireo.com/byok-1861384m0.md): 
- Root > Api's [Domains](https://reference.flireo.com/domains-1861385m0.md): 
- Root > Api's [Analysis templates](https://reference.flireo.com/analysis-templates-1892892m0.md): 
- Root > Api's [Tool templates](https://reference.flireo.com/tool-templates-1892895m0.md): 
- Root > Webhooks [Overview](https://reference.flireo.com/overview-1861386m0.md): 
- Root > Webhooks [Assistant request](https://reference.flireo.com/assistant-request-1861387m0.md): 
- Root > Webhooks [Tool calls](https://reference.flireo.com/tool-calls-1861388m0.md): 
- Root > Webhooks [Status update](https://reference.flireo.com/status-update-1861389m0.md): 
- Root > Webhooks [End of call report](https://reference.flireo.com/end-of-call-report-1861390m0.md): 
- Root > Webhooks [Security](https://reference.flireo.com/security-1861391m0.md): 
- Root > Guides [BYOK Setup](https://reference.flireo.com/byok-setup-1861392m0.md): 
- Root > Guides [Call analysis](https://reference.flireo.com/call-analysis-1861393m0.md): 
- Root > Guides [Custom Tools](https://reference.flireo.com/custom-tools-1861394m0.md): 
- Root > Guides [Call Transfers](https://reference.flireo.com/call-transfers-1861395m0.md): 
- Root > Guides [xAI Realtime Integration](https://reference.flireo.com/xai-realtime-integration-1892920m0.md): 
- Root > Guides [Analysis templates](https://reference.flireo.com/analysis-templates-1894216m0.md): 
- Root > Guides [Billing](https://reference.flireo.com/billing-1894217m0.md): 
- Root > Guides [Error codes](https://reference.flireo.com/error-codes-1894218m0.md): 
- Root > Guides [Rate limits](https://reference.flireo.com/rate-limits-1894219m0.md): 
- Root > Guides [Sip Trunks](https://reference.flireo.com/sip-trunks-1894220m0.md): 
- Root > Guides [Tool templates](https://reference.flireo.com/tool-templates-1894221m0.md): 
- Root > Guides [Troubleshooting](https://reference.flireo.com/troubleshooting-1894222m0.md): 

## API Docs
- Root > Agents [List all agents](https://reference.flireo.com/api-reference/assistants/list.md): Retrieve all AI voice agents in your organization.
- Root > Agents [Create a new agent](https://reference.flireo.com/api-reference/assistants/create.md): Create a new AI voice agent with custom STT, LLM, and TTS configurations. Only the name is required - defaults will be applied for other settings.
- Root > Agents [Get an agent](https://reference.flireo.com/api-reference/assistants/get.md): Retrieve a specific agent by ID.
- Root > Agents [Update an agent](https://reference.flireo.com/api-reference/assistants/update.md): Update an existing agent. Only provided fields will be updated.
- Root > Agents [Delete an agent](https://reference.flireo.com/api-reference/assistants/delete.md): Delete an agent. Any phone numbers assigned to this agent will have their agent_id set to null.
- Root > Tool Templates [List all tool templates](https://reference.flireo.com/api-reference/tools/list.md): Retrieve all tool templates in your organization.
- Root > Tool Templates [Create a new tool template](https://reference.flireo.com/api-reference/tools/create.md): Create a new reusable tool template. Tools can be of type 'function' (custom webhook), 'endCall' (built-in), or 'transferCall' (built-in).
- Root > Tool Templates [Get a tool template](https://reference.flireo.com/api-reference/tools/get.md): Retrieve a specific tool template by ID.
- Root > Tool Templates [Update a tool template](https://reference.flireo.com/api-reference/tools/update.md): Update an existing tool template. Only provided fields will be updated.
- Root > Tool Templates [Delete a tool template](https://reference.flireo.com/api-reference/tools/delete.md): Delete a tool template. Note that agents using this tool will continue to work as tools are stored as objects in the agent configuration, not as references.
- Root > Numbers [List all phone numbers](https://reference.flireo.com/api-reference/numbers/list.md): Retrieve all phone numbers in your organization with their assigned agents and transfer trunks.
- Root > Numbers [Register a phone number](https://reference.flireo.com/api-reference/numbers/create.md): Register a new phone number in your organization. The number must be configured with your SIP provider to forward calls to Flireo.
- Root > Numbers [Get a phone number](https://reference.flireo.com/api-reference/numbers/get.md): Retrieve a specific phone number by ID.
- Root > Numbers [Update a phone number](https://reference.flireo.com/api-reference/numbers/update.md): Update agent assignment or transfer trunk for a phone number.
- Root > Numbers [Delete a phone number](https://reference.flireo.com/api-reference/numbers/delete.md): Remove a phone number from your organization.
- Root > Calls [List calls](https://reference.flireo.com/api-reference/calls/list.md): Retrieve call history with optional filtering by status and date range. Returns complete call data including transcripts, analysis results, and metadata.
- Root > Calls [Get call by ID](https://reference.flireo.com/api-reference/calls/get.md): Retrieve complete details for a specific call including transcript, analysis results, and all metadata.
- Root > Calls [Initiate outbound call](https://reference.flireo.com/api-reference/calls/create.md): Initiate an outbound call from an AI agent to a destination phone number.
- Root > Call Control [Send control command to active call](https://reference.flireo.com/api-reference/call-control/create.md): Send real-time commands to an active call. The call must be in "in-progress" status.
- Root > Usage [Get usage logs](https://reference.flireo.com/api-reference/usage/get.md): Retrieve your organization's usage logs with billing information and optional date filtering.
- Root > SIP Trunks [List SIP trunks](https://reference.flireo.com/api-reference/sip-trunks/list.md): Retrieve all SIP trunks configured for your organization's call transfers.
- Root > SIP Trunks [Create a SIP trunk](https://reference.flireo.com/api-reference/sip-trunks/create.md): Create a new SIP trunk for call transfers. Passwords are stored securely in Vault.
- Root > SIP Trunks [Get a SIP trunk](https://reference.flireo.com/api-reference/sip-trunks/get.md): Retrieve a specific SIP trunk by ID.
- Root > SIP Trunks [Delete a SIP trunk](https://reference.flireo.com/api-reference/sip-trunks/delete.md): Delete a SIP trunk. Any numbers using this trunk for transfers will have their transfer_trunk_id set to null.
- Root > Voices [List available voices](https://reference.flireo.com/api-reference/voices/list.md): Returns available voices based on your configuration.
- Root > BYOK [Get BYOK configurations](https://reference.flireo.com/api-reference/byok/.md): Retrieve all Bring Your Own Key configurations for your organization.
- Root > BYOK [Add BYOK configuration](https://reference.flireo.com/api-reference/byok/create.md): Add or update a Bring Your Own Key configuration. The API key is securely stored in Supabase Vault and only the vault secret ID is stored in the database.
- Root > BYOK [Delete BYOK configuration](https://reference.flireo.com/api-reference/byok/delete.md): Remove a Bring Your Own Key configuration. This will delete the secret from Vault and remove the reference from the database.
- Root > BYOK [Get BYOK provider configurations](https://reference.flireo.com/api-reference/byok-config/list.md): Retrieve available BYOK providers and their supported models
- Root > Domains [Get your domain](https://reference.flireo.com/api-reference/domains/list.md): Retrieve your organization's configured email domain from Resend. Requires a Resend API key to be configured via BYOK (Bring Your Own Key). Returns null if no domain is configured.
- Root > Domains [Add a domain](https://reference.flireo.com/api-reference/domains/create.md): Create a custom email domain in Resend for sending notifications from your organization. Requires a Resend API key configured via BYOK. You can only have one domain configured per organization.
- Root > Domains [Delete your domain](https://reference.flireo.com/api-reference/domains/delete.md): Remove your organization's configured email domain from both the database and Resend.
- Root > Domains [List available Resend domains](https://reference.flireo.com/api-reference/domains/sync/list.md): Fetch all domains configured in your Resend account. Use this to see which domains you can select for your organization's email notifications. Requires a Resend API key configured via BYOK.
- Root > Domains [Select and sync a Resend domain](https://reference.flireo.com/api-reference/domains/sync/create.md): Select a domain from your Resend account to use for your organization's email notifications. This syncs the domain configuration to your organization.
- Root > Domains [Verify domain DNS records](https://reference.flireo.com/api-reference/domains/verify.md): Trigger domain verification in Resend to check if DNS records are correctly configured. This updates the domain status based on Resend's verification results.
- Root > Domains [Refresh domain status](https://reference.flireo.com/api-reference/domains/refresh.md): Fetch the latest domain status from Resend and update your local configuration. Use this to check if verification has completed or if any records need attention.
- Root > Webhooks [Dynamic assistant configuration webhook](https://reference.flireo.com/webhook/assistant-request.md): Called **BEFORE** an inbound call is answered, allowing you to:
- Root > Webhooks [Tool/Function Call](https://reference.flireo.com/webhook/tool-calls.md): Called when the AI needs to execute a tool/function during the conversation.
- Root > Webhooks [Call Status Update](https://reference.flireo.com/webhook/status-update.md): Called when the call status changes. Use this to track call lifecycle.
- Root > Webhooks [End of Call Report](https://reference.flireo.com/webhook/end-of-call-report.md): Called after the call ends with a summary and optional structured analysis.
- Root > Analysis Templates [List analysis templates](https://reference.flireo.com/api-reference/analysis-templates/list.md): Get all analysis templates for your organization
- Root > Analysis Templates [Create analysis template](https://reference.flireo.com/api-reference/analysis-templates/create.md): Create a new analysis template for your organization
- Root > Analysis Templates [Get analysis template](https://reference.flireo.com/api-reference/analysis-templates/get.md): Retrieve a specific analysis template by ID
- Root > Analysis Templates [Update analysis template](https://reference.flireo.com/api-reference/analysis-templates/update.md): Update an existing analysis template
- Root > Analysis Templates [Delete analysis template](https://reference.flireo.com/api-reference/analysis-templates/delete.md): Delete an analysis template
- Root > Organization [Get organization information](https://reference.flireo.com/api-reference/account/get.md): Retrieve your organization details including balance, usage statistics, and resource counts. The organization is determined by the API key used for authentication.
- Root > Campaigns [List all campaigns](https://reference.flireo.com/api-reference/campaigns/list.md): Retrieve all outbound campaigns in your organization.
- Root > Campaigns [Create a campaign](https://reference.flireo.com/api-reference/campaigns/create.md): Create a new outbound calling campaign with leads and schedule.
- Root > Campaigns [Get a campaign](https://reference.flireo.com/api-reference/campaigns/get.md): Retrieve a specific campaign by ID.
- Root > Campaigns [Update a campaign](https://reference.flireo.com/api-reference/campaigns/update.md): Update campaign settings or status. Set status to `scheduled` to start calling.
- Root > Campaigns [Delete a campaign](https://reference.flireo.com/api-reference/campaigns/delete.md): Delete a campaign and all its leads.
- Root > Campaigns [List campaign leads](https://reference.flireo.com/api-reference/campaigns/leads/list.md): Retrieve all leads in a campaign.
- Root > Campaigns [Add a lead](https://reference.flireo.com/api-reference/campaigns/leads/create.md): Add a new lead to a campaign.
- Root > Campaigns [Remove a lead](https://reference.flireo.com/api-reference/campaigns/leads/delete.md): Remove a lead from a campaign.