Ejento APIs
V2
  • Stable
  • V2
  • V2 Legacy
  1. Agent Tools
Ejento APIs
V2
  • Stable
  • V2
  • V2 Legacy
  • Overview
  • Authentication
    • Authenticate User
    • Request Passwordless Exchange Token
    • Exchange Passwordless Token for Access Tokens
    • Register User
    • Update Own Password
    • Refresh Access Token
  • Agents
    • Agent Access
      • Get Agent Access
      • Update Agent Access
    • Agent Alias
      • Get Agent Alias
      • Create an Agent Alias
      • Update an Agent Alias
      • Delete an Agent Alias
      • Get all Agent Aliases
    • Agent Tags
      • Add or Remove Tags from an Agent
      • Get all Tags for a given Project, Team, or Organization
      • Get all Tags grouped by Agent for a given Project, Team, or Organization
    • Agent Chat Threads
      • Get Chat Threads of an Agent
      • Create Chat Thread for an Agent
    • Agent Comment
      • Get all Comments for an Agent
      • Create a Comment
      • Update a Comment
      • Delete a Comment
    • Agent Rating
      • Get Ratings of an Agent
      • Update Agent Rating
      • Get all Agent Ratings
    • Agent Review
      • Get all Reviews for specific Agent
      • Create a new Review
      • Get all Reviews of the Authenticated User
      • Update a Review
      • Delete a Review
    • Agent Tools
      • List all Tools with their enabled status for the given Agent
        GET
      • Unlink an Agent from a Tool
        DELETE
      • Link an Agent to a Tool
        POST
      • List all tools that are connected to the Agent
        GET
    • Agent User
      • Get Users of an Agent
      • Add user to Agent
      • Delete User from Agent
      • Get all Agents Users
    • Agent User Permission
      • Get User Agent Permission
    • Agent Vote
      • Get Vote Information for an Agent
      • Vote on an Agent
    • Agent Type
      • Get all Agent Types
      • Get a specific Agent Type
      • Update a specific Agent Type
    • Get all Agents
      GET
    • Create a new Agent
      POST
    • Get an Agent
      GET
    • Update an Agent
      PUT
    • Delete an Agent
      DELETE
    • Activate an Agent
      PUT
    • Get Agent-Corpus Connections
      GET
    • Delete Agent-Corpus Connections
      DELETE
    • Get Agent-Corpus Connection Details
      GET
    • Create Agent-Corpus Connection
      POST
    • Update Agent-Corpus Connection
      PUT
    • Delete Agent-Corpus Connection
      DELETE
    • Get agent history with pagination
      GET
    • Restore an agent to a previous checkpoint
      PUT
    • Create Custom Instructions for an Agent
      POST
    • Get Agent Prompt History
      GET
    • Create a Recent Agent
      POST
    • Delete a Recent Agent
      DELETE
    • Get Agent Details with Starred Status
      GET
    • Create Starred Agent
      POST
    • Delete Starred Agent
      DELETE
    • Get the Status of an Agent
      GET
    • Get User's Team Role for an Agent
      GET
    • Create or Update an Agent using the Agent Builder
      POST
    • Get Agent Filter
      GET
    • Generate an image for an agent based on the provided description
      POST
    • Get all Agents by Project
      GET
    • Get list of Recent Agents
      GET
    • Get all Starred Agents of the Authenticated User
      GET
    • Get Agents accessible to the Current User across their Teams
      GET
    • Get Agents by Project team, User team
      GET
  • Agent Response
    • Get an Agent Response
    • Create 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
    • Update an Agent Response
    • Generate Agent Response (Non-Streaming)
    • Stream Agent Response (SSE)
  • Chat Thread
    • Agent Response
      • Get Agent Responses for a Chat Thread
      • Delete Agent Responses for a Chat Thread
    • Chat Logs
      • Get Chat Logs for a Chat Thread
    • Corpus Connection
      • Get Corpus Connection by ChatThread ID
      • Delete Corpus Connection by ChatThread ID
      • Get a ChatThread-Corpus connection
      • Create a ChatThread-Corpus connection
      • Delete a ChatThread-Corpus connection
    • Documents
      • Get Documents in Chat Thread
    • Get Chat Thread
    • Update Chat Thread
    • Delete Chat Thread
    • Get Chat Threads based on various filters
  • Chat Logs
    • Get Chat Log Details
    • Get Chat Log Search Results
  • Conversation Starters
    • Get Conversation Starters for an Agent
    • Create a new Conversation Starter.
  • Teams
    • Get all Teams
    • Create a Team
    • Get a Team
    • Update a Team
    • Delete a Team
    • Get all Projects of a Team
    • Create a Recent Team
    • Get all Users in a Team
    • Add Users to a Team
    • Remove User from Team
    • Update User Role in Team
    • Get Recent Teams
    • Get all Teams of the Authenticated User
    • Get all Agents of User's Team
  • Projects
    • 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
    • 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
    • Get all Permissions for a Corpus
    • Create a new Permission for a Corpus
    • Delete a user permission for a corpus
    • Get all user permissions for a corpus
    • Trigger a Refresh (Reindex) of a Corpus
    • Get Corpora with Refresh (Reindex) Enabled
  • Documents
    • Get a Document
    • Update a Document
    • Delete a Document
    • Annotate a Document
    • Get Conversation Starters for a Document
    • Trigger a Refresh (Reindex) of a Document
    • Retrieve multiple Documents by IDs
  • Organizations
    • 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
    • Get all LLM configurations of the user's Organization
    • Get a specific LLM configuration by ID
  • Users
    • Get a User
    • Update a User
    • Delete a User
    • Get Agent Responses of a User
    • Get all User Permissions
    • Create a new User Organization Permission
    • Update the Organization Permission of a User
    • Delete a User Organization Permission
    • Get Projects of a User
    • Get all Workflow Tables for a User
    • Get all Workflows for a User
    • Delete multiple Users
    • Get a specific User by user_email
    • Get all Users
    • Get authenticated User
    • Get User Projects
  • 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 Query Count Data
    • Get Token Data
  • Configurations
    • Update the LLM configuration for an Agent
    • Get OAuth-related Feature Flags
  • Evaluations
    • Retrieve all evaluations or filter by dataset
    • Create a new evaluation
    • Delete a set of evaluations or a specific evaluation
    • Retrieve all evaluation datasets for a specific agent
    • Create a new evaluation dataset for the given agent
    • Delete multiple datasets or all datasets for an agent
    • Retrieve a specific evaluation
    • Update an evaluation run
    • Delete a specific evaluation
    • List query results for an evaluation run
    • Create a query result and save metrics
    • Retrieve a specific dataset
    • Update an evaluation dataset
    • Delete a specific dataset
    • Retrieve queries for an evaluation dataset
    • Create a new query for evaluation
    • Retrieve all unique tags from all datasets in the organization
    • Get a specific metric result by ID
    • Retrieve all metrics or filter by category name
    • Create a new metric
    • Retrieve a specific metric
    • Update a metric
    • Delete a metric
    • Get all metric results for a specific metric
    • Create a new metric result entry for the given metric
    • Retrieve a specific evaluation query
    • Update an evaluation query
    • Delete an evaluation query
    • Get a specific query result with metrics
    • Update a query result
  • Guardrails
    • Get available guardrail types for agent
    • Apply Guardrails on Input Text
    • Enable/disable a guardrail type for agent
    • Get Guardrails
    • Update Guardrails
    • Delete Guardrails
    • Get Guardrails in Organization
    • Create Guardrail in Organization
    • Enable or Disable Guardrail for Organization
  • Feature Flags
    • Get All Feature Flags
    • Get Agent Alias Feature Flag
    • Get Api Tools Feature Flag
    • Get Caching Feature Flag
    • Get Chat Agent Creation Feature Flag
    • Get dall_e Image Generation Feature Flag
    • Get Developer Portal Feature Flag
    • Get Guardrail Feature Flag
    • Get PII Redaction Feature Flag
    • Get Share Agent Feature Flag
    • Get Sharepoint Connector Feature Flag
    • Get Sharepoint Index Feature Flag
    • Get Youtube Index Feature Flag
  • Notifications
    • Get all Notifications
    • Create a new Notification
    • Update Notifications by User ID
    • Get a Notification
    • Update a Notification
    • Delete a Notification
  • Tools
    • Get Tool by ID
    • Update Tool by ID
    • Delete Tool by ID
  • Workflows
    • Get all Workflows
    • Create a Workflow
    • Get a Workflow
    • Update a Workflow
    • Delete a Workflow
    • Get all Workflow Chat Threads
    • Create a Workflow Chat Thread
    • Get a Workflow Chat Thread
    • Update a Workflow Chat Thread
    • Delete a Workflow Chat Thread
    • Get all Workflow Chat Responses
    • Create a Workflow Chat Response
    • Delete a Workflow Response
    • Create a Workflow Feedback
    • Create a Workflow Review
    • Retrieve a list of reviews for a given workflow response
  1. Agent Tools

List all Tools with their enabled status for the given Agent

GET
/api/v2/agents/{agent_id}/tools
List all tools with their enabled status for the given agent.
Purpose:
Enables users to view all tools with their enabled status for a given agent.
Path Parameters:
agent_id (int): ID of the agent.
Query Parameters:
is_connected: Whether to filter tools by connection status. Accepts 'true' for connected tools and 'false' for disconnected tools. No is_connected will return all tools.
verbosity: The verbosity of the response. Accepts 'low', 'medium', 'high'. Default is 'medium'.
is_enabled: Whether to filter tools by enabled status. Accepts 'true' for enabled tools and 'false' for disabled tools. No is_enabled will return all tools.
paginated (optional): Whether to paginate the response.
page (optional): The page number to return.
items_per_page (optional): The number of items per page.
query (optional): The query to search for tools.
sort_by (optional): The field to sort the tools by. Default is 'created_on'. Options are 'modified_on', 'created_on', 'name', 'description', 'tool_type', 'is_enabled', 'is_default', 'created_by', 'connection'.
search (str): Search term to filter tools by name or description (case-insensitive substring match).
category (str): Filter by category name.
tool_classification (str): Filter by tool classification ('Internal' or 'External').
tool_type (str): Filter by tool type (rag, api, web_search, attachment, retriever, mcp).
Returns:
A JSON response with the serialized tool data or an error message.
A 400 Bad Request error if the version is invalid.
A 500 Internal Server Error for any unexpected failures.
Current Version:
2.1.6
Changelog:
2.0.1: Added tool ordering by modified_on field
2.1.0: Added pagination support
2.1.1: Added query parameter to search for tools
2.1.2: Added sort_by parameter to sort the tools
2.1.3: Added category parameter to filter tools by category
2.1.4: Added tool_classification parameter to filter tools by tool classification
2.1.5: Added category, tool_classification, tool_type filters in logic alignment with organization endpoint
2.1.6: Modified is_enabled and is_connected filters to allow both true and false values

Request

Path Params

Query Params

Header Params

Responses

🟢200OK
application/json
Body

🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https:///api/v2/agents//tools' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '
Response Response Example
200 - Example 1
{
    "success": true,
    "message": "string",
    "data": {
        "items": [
            {
                "id": 0,
                "name": "string",
                "description": "string",
                "org": 0,
                "tool_type": "rag",
                "created_by": "string",
                "is_enabled": true,
                "is_default": true,
                "connection": true,
                "tool_classification": "string",
                "category": "string"
            }
        ],
        "meta": {
            "property1": null,
            "property2": null
        }
    }
}
Previous
Delete a Review
Next
Unlink an Agent from a Tool
Built with