Skip to main content
GET
/
ai-agents
/
agent-builder
/
api-tools
List API Tools
curl --request GET \
  --url https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/api-tools \
  --header 'apikey: <api-key>'
{
  "data": [
    {
      "_id": "myapp_my-api-tool",
      "appId": "my-app-id",
      "slug": "my-api-tool",
      "name": "My API Tool",
      "description": "Calls an external API",
      "icon": "https://example.com/icon.png",
      "endpoint": "https://api.example.com/search",
      "method": "GET",
      "enableBasicAuth": false,
      "headers": "{\"Content-Type\":\"application/json\"}",
      "bodyTemplate": "{\"query\":\"{{query}}\"}",
      "allowAdditionalProperties": false,
      "parameters": [
        {
          "key": "query",
          "type": "string",
          "description": "The search query",
          "required": true
        }
      ],
      "tool": {
        "name": "my-api-tool",
        "description": "Calls an external API",
        "parameters": {
          "type": "object",
          "properties": {},
          "required": []
        }
      },
      "createdAt": 1700000000000,
      "updatedAt": 1700000000000
    }
  ],
  "meta": {
    "previous": {
      "affix": "prepend",
      "createdAt": 1700000000000
    },
    "current": {
      "limit": 10,
      "count": 1
    },
    "next": {
      "affix": "append",
      "createdAt": 1700000000000
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://cometchat-22654f5b-docs-android-v6-beta2.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

For the complete error reference, see Error Guide.

Authorizations

​
apikey
string
header
required

API Key (i.e. Rest API Key from the Dashboard).

Query Parameters

​
limit
number

Maximum number of results to return per page.

​
affix
enum<string>

To paginate over results, use the value of affix as prepend or append.

Available options:
prepend,
append
​
createdAt
number

To be used with affix for pagination.

Response

200 - application/json

Paginated list of API tools

​
data
object[]
​
meta
object