Sign in
OpenAPI 3.1.1Apache 2.02026-08-20111286594.7 KB

70d3494a20f5

Tool Calling

List available tools

Tools that can be made available for a connected-account identifier. Use this when you need the candidate set for an identifier, not the tools already scoped to it. identifier is required. Distinct from GET /api/v1/tools/scoped.

get/api/v1/tools/available

Query parameters

identifierstring required

Identifier of the connected account to list available tools for

page_sizeinteger

Maximum number of tools to return per page

page_tokenstring

Token from a previous response for pagination

Response

Paginated list of tools available for the identifier

next_page_tokenstring

Token for fetching the next page of tools

prev_page_tokenstring

Token for fetching the previous page of tools

total_sizeinteger

Total number of available tools matching the query

Example response

{
  "next_page_token": "eyJwYWdlIjozLCJsaW1pdCI6MzB9",
  "prev_page_token": "eyJwYWdlIjoxLCJsaW1pdCI6MzB9",
  "tools": [
    {
      "definition": {
        "input": {
          "type": "object"
        }
      },
      "id": "tol_123",
      "is_default": true,
      "metadata": {
        "category": "email"
      },
      "provider": "GOOGLE",
      "tags": [
        "notification",
        "email"
      ],
      "updated_at": "2023-10-01T12:00:00Z"
    }
  ],
  "total_size": 104
}