Get Agent Filter

GET

/api/v2/agents/filter

Fetches agents based on date range, project IDs, and user interaction filters.

Query Parameters:

start_date: ISO format date (optional, defaults to 30 days ago)

end_date: ISO format date (optional, defaults to current date)

from_date: YYYY-MM-DD format date (optional)

to_date: YYYY-MM-DD format date (optional)

timezone: Timezone string (optional, defaults to UTC)

project_ids: comma-separated list of project IDs (optional)

user_ids: comma-separated list of user IDs (optional)

response_quality: Filter by response quality. Valid values: 'upvote', 'downvote'. (optional)

comments: Filter to agents that have comments. Valid values: 'true', 'false'. (optional)

query_source: Filter by query source string (optional)

success_status: Filter by response success status. Valid values: 'successful', 'failed'. (optional)

Returns:

A JSON response with the serialized agent data if the agent is found.

A JSON response with an error message if the agent is not found or if an error occurs.

A 400 Bad Request error if the version is invalid.

A 500 Internal Server Error for any unexpected failures.

Current Version:

2.0.0

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Success

Bodyapplication/json

🟠400Bad Request

🟠403Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/agents/filter?comments=&end_date=&from_date=&project_ids=&query_source=&response_quality=&start_date=&success_status=&timezone=&to_date=&user_ids=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "agents": [
            {
                "id": 0,
                "agent_name": "string",
                "created_by": "string",
                "user": 0,
                "project": 0
            }
        ]
    }
}

Get all Character Voices

Generate an image for an agent based on the provided description