- Overview
- Changelog
- Versioning
- Quick-Start Template for Building an App
- FAQs
- Guides
- Authentication
- Agents
- Agent Access
- Agent Alias
- Agent Tags
- Agent Chat Threads
- Agent Comment
- Agent Rating
- Agent Review
- Agent Tools
- Agent Vote
- Agent Type
- Evaluation Datasets
- Evaluation Runs
- Agent Permissions
- Get all AgentsGET
- Create a new AgentPOST
- Get an AgentGET
- Update an AgentPUT
- Delete an AgentDELETE
- Activate an AgentPUT
- Get Agent-Corpus ConnectionsGET
- Create Multiple Agent-Corpus ConnectionsPOST
- Delete Agent-Corpus ConnectionsDELETE
- Get Agent-Corpus Connection DetailsGET
- Create Agent-Corpus ConnectionPOST
- Update Agent-Corpus ConnectionPUT
- Delete Agent-Corpus ConnectionDELETE
- Get agent history with paginationGET
- Restore an agent to a previous checkpointPUT
- Get a single agent history record by history IDGET
- Create Custom Instructions for an AgentPOST
- Update Custom Instructions for an AgentPUT
- Delete a Custom Instruction for an AgentDELETE
- Get Agent Prompt HistoryGET
- Create a Recent AgentPOST
- Delete a Recent AgentDELETE
- Get Agent Details with Starred StatusGET
- Create Starred AgentPOST
- Delete Starred AgentDELETE
- Get the Status of an AgentGET
- Get all Character VoicesGET
- Get Agent FilterGET
- Generate an image for an agent based on the provided descriptionPOST
- Get all Agents by ProjectGET
- Get list of Recent AgentsGET
- Get all workflows for an agentGET
- Get all Starred Agents of the Authenticated UserGET
- Get Staging DiffGET
- Get publish history for an agentGET
- Get rollback diff preview for a publish recordGET
- Roll back staging agent to a previous publishPUT
- Publish staging agent to mainPOST
- Clone an AgentPOST
- Get diff detail for a publish recordGET
- Agent Access
- Agent Response
- Stream Agent Response (SSE)
- Generate Agent Response (Non-Streaming)
- Generate Token for Voice Call
- Get an Agent Response
- Update an Agent Response
- Delete an Agent Response
- Get Comments for Agent Response
- Create a Comment for Agent Response
- Create a Feedback for an Agent Response
- Pin an Agent Response
- Unpin an Agent Response
- Get Supporting Content of an Agent Response
- Get Thoughts of an Agent Response
- Get Agent Responses based on filters
- Get Agent Responses of an Agent
- Create Agent Response Log
- Get Pinned Agent Responses
- Create Bulk Agent Response Logs
- Chat Thread
- Chat Logs
- Conversation Starters
- Teams
- Projects
- Project Permissions
- Retrieve all Projects
- Create a Project
- Get a Project
- Update a Project
- Delete a Project
- Get Agent Responses using Project ID
- Add a Recent Project for a User
- Add Users to a Project
- Remove a User from a Project
- Get all Workflows for a Project
- Get multiple Projects by their IDs
- Get Projects based on filters
- Get Recent Projects for a User
- Get Projects with Team Details
- Corpora
- Corpus Permissions
- Get all Permissions for a Corpus
- Grant permission on a corpus
- Update a permission on a corpus
- Revoke permission on a corpus
- Batch grant permissions on a corpus
- Batch revoke permissions on a corpus
- Get calling user's permissions on a corpus
- Get a user's permissions on a corpus
- Get a user's permissions across multiple corpora
- Get all Corpus
- Upload a Document to a Corpus
- Create a Corpus
- Get a Corpus
- Update a Corpus
- Delete a Corpus
- Get Corpus Agent Connections
- Get Default Corpus Agent Connection
- Annotate/Tag a Corpus
- Get Conversation Starters for a Corpus
- Get all Documents for a Corpus
- Delete Document(s) from a Corpus
- Check Duplicate Documents in a Corpus
- Trigger a Refresh (Reindex) of a Corpus
- Get Sitemaps for a Corpus
- Get Corpora with Refresh (Reindex) Enabled
- Corpus Permissions
- Documents
- Organizations
- Organization Permissions
- Get all Configurations
- Get active configuration for an Organization
- Get the Model Deployment for an Organization
- Get all Tools in an Organization
- Disable a Tool for all Agents in an Organization
- Enable a Tool for all Agents in an Organization
- Get all API Tool Templates
- Create a new API Tool Template
- Create a new API tool
- Create an attachment tool
- Create a new RAG tool in an Organization
- Create a Web Search Tool in an Organization
- Get all Users in an Organization
- Create a User in an Organization
- Get all Configurations of user's Organization
- Register LLM Configuration
- Update LLM Configuration
- Toggle LLM Configuration Availability
- Delete LLM Configuration
- Get a specific LLM configuration by ID (admin only)
- Users
- Analytics
- Get Agent Cost Data
- Get Agent Document Count Data
- Get Agent Indexing Mode Data
- Get Agent Most Active Data
- Get Agent Query Count Data
- Get Recent Agent Data
- Get Agent Summary Statistics
- Get Agent Token Data
- Get Agent Vote Data
- Get Corpus Document Count Data
- Get Corpus Indexing Mode Data
- Get Cost Data
- Get Document Count Data
- Get Indexing Mode Data
- Get Project Cost Data
- Get Project Document Count Data
- Get Project Indexing Mode Data
- Get Project Most Active Data
- Get Project Query Count Data
- Get Recent Project Data
- Get Project Summary Statistics
- Get Project Token Data
- Get Project Vote Data
- Get Overall Summary Statistics
- Get Team Cost Data
- Get Team Document Count Data
- Get Team Indexing Mode Data
- Get Team Most Active Data
- Get Team Query Count Data
- Get Recent Team Data
- Get Team Summary Statistics
- Get Team Token Data
- Get Team Vote Data
- Get Total Entity Counts
- Get User Cost Data
- Get User Document Count Data
- Get User Indexing Mode Data
- Get User Most Active Data
- Get User Query Count Data
- Get Recent User Data
- Get User Summary Statistics
- Get User Token Data
- Get User Vote Data
- Get Vote Count Data
- Get Workflow Summary Statistics
- Get Query Count Data
- Get Token Data
- Configurations
- Guardrails
- Feature Flags
- Get All Feature Flags
- Get Agent Alias Feature Flag
- Get Agent Evaluation Feature Flag
- Get Api Tools Feature Flag
- Get Caching Feature Flag
- Get Call Feature Flag
- Get Chat Agent Creation Feature Flag
- Get Chat Widget Feature Flag
- Get dall_e Image Generation Feature Flag
- Get Developer Portal Feature Flag
- Get Flush Cache Feature Flag
- Get Google Drive Connector Feature Flag
- Get Guardrail Feature Flag
- Get PII Redaction Feature Flag
- Get Share Agent Feature Flag
- Get Sharepoint Legacy Feature Flag
- Show Quota Limit Feature Flag
- Get Staging Agent Feature Flag
- Get Workflow Evaluation Feature Flag
- Get Youtube Index Feature Flag
- Notifications
- Tools
- Workflows
- Evaluation Datasets
- Evaluation Runs
- Workflow Permissions
- Get all Workflows
- Stream Workflow Response (SSE)
- Create a Workflow
- Get a Workflow
- Update a Workflow
- Delete a Workflow
- Get all Workflow Chat Threads
- Create a Workflow Chat Thread
- Get all Workflow Responses
- Create a Workflow Chat Response
- Get a Workflow Chat Thread
- Update a Workflow Chat Thread
- Delete a Workflow Chat Thread
- Get all Workflow Chat Responses
- Delete a Workflow Response
- Create a Workflow Feedback
- Retrieve a list of reviews for a given workflow response
- Create a Workflow Review
- Get Workflow Responses based on filters
- Citation
- Sitemaps
- Google Drive
Get Agent Filter
GET
/api/v2/agents/filter
Request
Query Params
Header Params
Responses
🟢200OK
application/json
Bodyapplication/json
🟠400Bad Request
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https:///api/v2/agents/filter?comments=undefined&end_date=undefined&from_date=undefined&project_ids=undefined&query_source=undefined&response_quality=undefined&start_date=undefined&success_status=undefined&timezone=undefined&to_date=undefined&user_ids=undefined' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer 'Response Response Example
200 - Example 1
{
"success": true,
"message": "string",
"data": {
"agents": [
{
"id": 0,
"agent_name": "string",
"created_by": "string",
"user": 0,
"project": 0
}
]
}
}