Get Tool

Retrieves a specific tool by its unique name. Use this endpoint to inspect a tool’s configuration, parameters, and description.

GET /ai-agents/tools/{name}

Get Tool

cURL

curl --request GET \
  --url https://{appid}.api-{region}.cometchat.io/v3/ai-agents/tools/{name} \
  --header 'apikey: <api-key>'

200

{
  "_id": "myapp_myTool",
  "appId": "my-app-id",
  "name": "myTool",
  "type": "action",
  "displayName": "My Tool",
  "executionText": "Running my tool...",
  "doNotExecute": false,
  "tool": {
    "name": "myTool",
    "description": "A helpful tool",
    "parameters": {
      "type": "object",
      "properties": {},
      "required": []
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Path Parameters

name · string · required

Response

200

application/json

Tool details

_id · string

Example:

"myapp_myTool"

appId · string

Example:

"my-app-id"

name · string

Example:

"myTool"

type · enum<string>

Available options: action, tool

Example:

"action"

displayName · string

Example:

"My Tool"

executionText · string

Example:

"Running my tool..."

doNotExecute · boolean

Example:

false

tool · object

Show child attributes

createdAt · string<date-time>

updatedAt · string<date-time>