Get an agent

GET

https://api.flireo.com/api/v1/agents/{id}

Agents

Last modified:2026-01-09 14:25:39

Maintainer:Not configured

Retrieve a specific agent by ID.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Agent details

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.flireo.com/api/v1/agents/' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "agent": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "Customer Support Agent",
        "business_name": "Acme Corp",
        "notification_email": "support@acme.com",
        "first_message": "Hallo, welkom bij Acme. Waarmee kan ik u helpen?",
        "is_active": true,
        "webhook_url": "http://example.com",
        "webhook_secret": "string",
        "webhook_events": [
            "string"
        ],
        "analysis_plan": {
            "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
        },
        "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"
        },
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-01-09 14:25:39

Create a new agent

Update an agent