Flireo AI
WebsiteLinkedin
WebsiteLinkedin
  1. Core concepts
  • 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
  • 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. Core concepts

Agents

Agents are AI-powered voice assistants that handle phone conversations. Each agent has its own personality, knowledge, and capabilities defined through configuration.

Agent Components#

An agent consists of three main AI components:

Speech-to-Text (STT)#

Converts the caller's speech to text. Currently powered by Deepgram.
{
  "stt_config": {
    "provider": "deepgram",
    "model": "nova-3-general",
    "language": "nl"
  }
}
FieldDescription
providerSTT provider (deepgram)
modelModel name (e.g., nova-3-general)
languageLanguage code (e.g., nl, en)

Language Model (LLM)#

The brain of your agent. Processes the conversation and generates responses.
{
  "llm_config": {
    "provider": "openai",
    "model": "gpt-4o-mini",
    "temperature": 0.7,
    "messages": [
      {
        "role": "system",
        "content": "Je bent een vriendelijke klantenservice medewerker..."
      }
    ],
    "tools": []
  }
}
FieldDescription
providerLLM provider (openai, anthropic, groq)
modelModel name (e.g., gpt-4o-mini, claude-3-sonnet)
temperatureResponse randomness (0-2, default 0.7)
messagesSystem prompts defining agent behavior
toolsCustom tools the agent can use (see Custom Tools)

Text-to-Speech (TTS)#

Converts the agent's text responses to speech.
{
  "tts_config": {
    "provider": "openai",
    "voiceId": "alloy"
  }
}
FieldDescription
providerTTS provider (openai, elevenlabs, cartesia)
voiceIdVoice identifier
modelModel name (for providers that support multiple models)

Agent Properties#

PropertyTypeDescription
idUUIDUnique identifier (auto-generated)
namestringDisplay name for the agent
business_namestringBusiness the agent represents
notification_emailemailEmail for call notifications
first_messagestringInitial greeting when call starts
is_activebooleanWhether agent can handle calls
webhook_urlURLEndpoint for webhook events
webhook_secretstringSecret for signature verification
webhook_eventsarrayEvents to send to webhook
analysis_planobjectPost-call analysis configuration

Creating an Agent#

Only the name is required. All other fields have sensible defaults.
Minimal agent:
Full agent:
See Create a New Agent for complete API documentation.

Updating an Agent#

Use PATCH to update specific fields. Only provided fields are updated.
See Update an Agent for details.

Deleting an Agent#

When you delete an agent, any phone numbers assigned to it will have their agent_id set to null.
See Delete an Agent for details.

Related#

List All Agents
Get an Agent
Phone Numbers - Assign agents to phone numbers
Webhooks - Configure event notifications
Modified at 2025-12-29 14:20:28
Previous
Authentication
Next
Phone numbers
Built with