Flireo AI
WebsiteLinkedin
WebsiteLinkedin
    • 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

    AssistantRequestResponse

    Optional response to override assistant configuration or reject call.
    xAI Realtime Notes:
    When the agent uses xai_realtime, you can still override the configuration dynamically.
    The stt_config and tts_config fields will be ignored for xAI Realtime agents.

    {
        "assistant": {
            "firstMessage": "Hallo Jan, hoe kan ik je helpen vandaag?",
            "stt_config": {
                "provider": "deepgram",
                "model": "nova-3-general",
                "language": "nl"
            },
            "llm_config": {
                "provider": "openai",
                "model": "gpt-4o-mini",
                "voice": "ara",
                "temperature": 0.7,
                "messages": [
                    {
                        "role": "system",
                        "content": "string"
                    }
                ],
                "tools": [
                    {}
                ]
            },
            "tts_config": {
                "provider": "openai",
                "voiceId": "alloy",
                "model": "eleven_flash_v2_5"
            },
            "analysisPlan": {
                "structuredDataPlan": {
                    "enabled": true,
                    "schema": {
                        "type": "object",
                        "properties": {
                            "intent": {
                                "type": "string"
                            },
                            "sentiment": {
                                "type": "string",
                                "enum": [
                                    "positive",
                                    "neutral",
                                    "negative"
                                ]
                            },
                            "appointment_booked": {
                                "type": "boolean"
                            }
                        }
                    },
                    "messages": [
                        {
                            "role": "system",
                            "content": "Analyze the following call transcript according to this schema: {{schema}}"
                        }
                    ]
                },
                "minMessagesThreshold": 2
            }
        },
        "maxDurationSeconds": 300,
        "error": "Sorry, we are closed right now. Please call back during business hours."
    }
    Built with