OpenAPI 3.1.1Apache 2.02026-08-20111286594.7 KB

70d3494a20f5

Tool Calling

List scoped tools

Tools already bound to one connected-account identifier. Use this when you need the list a user or agent is authorized to call (the list you pass to an LLM). Filter by provider, tool name, or connection name. identifier is required.

get/api/v1/tools/scoped

Query parameters

identifierstring required

Identifier of the connected account to filter tools

filter.providersstring[]

Filter by one or more tool providers

filter.tool_namesstring[]

Filter by one or more tool names

filter.connection_namesstring[]

Filter by one or more connection names

page_sizeinteger

Maximum number of tools to return per page

page_tokenstring

Token from a previous response for pagination

Response

Paginated list of tools scoped to the given connected account 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 tools matching the query

Example response

{
  "next_page_token": "eyJwYWdlIjozLCJsaW1pdCI6MzB9",
  "prev_page_token": "eyJwYWdlIjoxLCJsaW1pdCI6MzB9",
  "tools": [
    {
      "connected_account_id": "ca_123",
      "tool": {
        "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
}