List Tool Integrations

Retrieves a paginated list of ready-to-use tool integrations available for the specified agent. Use this endpoint to discover and browse pre-built tool integrations.

Tool details: Each tool includes its slug, name, icon, description, available actions, and authentication status.

Pagination: Supports cursor-based pagination using the affix and createdAt query parameters. Optionally filter by slug or search by tool name.

GET /ai-agents/agent-builder/tools/agent/{agentUid}

List Tool Integrations

cURL

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

200

{
  "data": [
    {
      "slug": "gmail",
      "name": "Gmail",
      "icon": "https://example.com/gmail-icon.png",
      "description": "Gmail integration for sending and managing emails",
      "actions": [
        {
          "name": "GMAIL_SEND_EMAIL",
          "displayName": "Send Email"
        }
      ],
      "isAuthenticated": false
    }
  ],
  "meta": {
    "previous": {
      "affix": "prepend",
      "createdAt": 1700000000000
    },
    "current": {
      "limit": 10,
      "count": 5
    },
    "next": {
      "affix": "append",
      "createdAt": 1700000000000
    }
  }
}

Authorizations

apikey · string · header · required

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

Path Parameters

agentUid · string · required

AI Agent UID

Query Parameters

slug · string

Optional slug to filter integration (e.g., gmail, googlesheets)

limit · number

affix · enum<string>

Available options: prepend, append

createdAt · number

search · string

Search term for tool name or slug

Response

200

application/json

Available tool integrations retrieved successfully

data · object[]

Show child attributes

meta · object

Show child attributes