Flireo AI
WebsiteLinkedin
WebsiteLinkedin
  1. Get started
  • API Reference
    • Agents
      • List all agents
      • Create a new agent
      • Get an agent
      • Update an agent
      • Delete an agent
    • Tool Templates
      • List all tool templates
      • Create a new tool template
      • Get a tool template
      • Update a tool template
      • Delete a tool template
    • Numbers
      • List all phone numbers
      • Register a phone number
      • Get a phone number
      • Update a phone number
      • Delete a phone number
    • Calls
      • List calls
      • Get call by ID
      • Initiate outbound call
    • Call Control
      • Send control command to active call
    • Usage
      • Get usage logs
    • SIP Trunks
      • List SIP trunks
      • Create a SIP trunk
      • Get a SIP trunk
      • Delete a SIP trunk
    • Voices
      • List available voices
    • BYOK
      • Get BYOK configurations
      • Add BYOK configuration
      • Delete BYOK configuration
      • Get BYOK provider configurations
    • Domains
      • Get your domain
      • Add a domain
      • Delete your domain
      • List available Resend domains
      • Select and sync a Resend domain
      • Verify domain DNS records
      • Refresh domain status
    • Webhooks
      • Dynamic assistant configuration webhook
      • Tool/Function Call
      • Call Status Update
      • End of Call Report
    • Analysis Templates
      • List analysis templates
      • Create analysis template
      • Get analysis template
      • Update analysis template
      • Delete analysis template
    • Organization
      • Get organization information
    • Campaigns
      • List all campaigns
      • Create a campaign
      • Get a campaign
      • Update a campaign
      • Delete a campaign
      • List campaign leads
      • Add a lead
      • Remove a lead
    • Schemas
      • Error
      • Pagination
      • UUID
      • Timestamp
      • SuccessResponse
      • STTConfig
      • LLMConfig
      • TTSConfig
      • XAIRealtimeConfig
      • Agent
      • AgentCreate
      • AgentUpdate
      • PhoneNumber
      • PhoneNumberCreate
      • PhoneNumberUpdate
      • Call
      • CallControlCommand
      • InjectContextCommand
      • SayCommand
      • EndCallCommand
      • TransferCommand
      • CallControlResponse
      • Account
      • OutboundCallRequest
      • OutboundCallResponse
      • UsageLog
      • UsageSummary
      • Organization
      • SipTrunk
      • SipTrunkCreate
      • Voice
      • AssistantRequestPayload
      • CallObject
      • AssistantRequestResponse
      • XAIRealtimeVoice
      • Customer
      • AssistantConfigOverride
      • AnalysisPlan
      • ToolCallsPayload
      • ToolCall
      • ToolCallsResponse
      • StatusUpdatePayload
      • EndOfCallReportPayload
      • ToolDefinition
      • EndCallTool
      • TransferCallTool
      • WebhookHeaders
      • XAIRealtimeWebhookNotes
      • ToolFunctionConfig
      • ToolTransferConfig
      • ToolTemplate
      • ToolTemplateCreate
      • ToolTemplateUpdate
      • AnalysisTemplate
      • CreateAnalysisTemplate
      • UpdateAnalysisTemplate
      • AnalysisTemplateListResponse
      • CampaignLead
      • Campaign
      • CampaignCreate
      • CampaignUpdate
      • CampaignLeadCreate
  • Documentation
    • Get started
      • Quickstart
      • Introduction
      • Authentication
    • Core concepts
      • Agents
      • Phone numbers
      • Calls
      • Webhooks
    • Api's
      • Organization
      • Agents
      • Phone numbers
      • Sip trunks
      • Calls
      • Call control
      • Usage
      • Voices
      • BYOK
      • Domains
      • Analysis templates
      • Tool templates
    • Webhooks
      • Overview
      • Assistant request
      • Tool calls
      • Status update
      • End of call report
      • Security
    • Guides
      • BYOK Setup
      • Call analysis
      • Custom Tools
      • Call Transfers
      • xAI Realtime Integration
      • Analysis templates
      • Billing
      • Error codes
      • Rate limits
      • Sip Trunks
      • Tool templates
      • Troubleshooting
WebsiteLinkedin
WebsiteLinkedin
  1. Get started

Quickstart

This guide walks you through creating your first AI voice agent and making it available on a phone number.

Prerequisites#

A Flireo account with an API key
A phone number configured to forward calls to Flireo (contact support for SIP configuration)

Step 1: Get Your API Key#

Find your API key in the dashboard under Settings > API Keys. You'll use this for all API requests.

Step 2: Create an Agent#

Create a new AI agent with a simple POST request:
Response:
{
  "agent": {
    "id": "17a0cb75-fa09-4bdd-9a44-92a70d829c88",
    "name": "Customer Support Agent",
    "business_name": "Acme Corp",
    "first_message": "Hallo, welkom bij Acme. Waarmee kan ik u helpen?",
    "is_active": true,
    "stt_config": { ... },
    "llm_config": { ... },
    "tts_config": { ... },
    "created_at": "2025-12-13T10:00:00.000Z",
    "updated_at": "2025-12-13T10:00:00.000Z"
  }
}
Save the id - you'll need it to assign a phone number.

Step 3: Register a Phone Number#

Register your phone number and assign the agent:
Response:
{
  "number": {
    "id": "abc12345-1234-5678-9012-abcdef123456",
    "phone_number": "+31850835037",
    "name": "Main Support Line",
    "agent_id": "17a0cb75-fa09-4bdd-9a44-92a70d829c88",
    "created_at": "2025-12-13T10:05:00.000Z"
  }
}

Step 4: Test Your Agent#

Call the phone number you registered. Your AI agent will answer and greet the caller with the configured first message.

Step 5: View Call History#

After the call, view it in your call history:
Response:
{
  "calls": [
    {
      "id": "call-_+31612345678_abc123",
      "caller_phone": "+31612345678",
      "assistant_phone": "+31850835037",
      "status": "ended",
      "duration_seconds": 45,
      "summary": "Klant vroeg naar openingstijden.",
      "agent_name": "Customer Support Agent",
      "created_at": "2025-12-13T10:10:00.000Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 100,
    "offset": 0
  }
}

Next Steps#

Configure webhooks to receive real-time call events
Add custom tools to let your agent look up information
Set up BYOK to use your own API keys
Enable call analysis for structured post-call data
Modified at 2026-01-09 15:20:03
Previous
CampaignLeadCreate
Next
Introduction
Built with