List tools available to a user Beta

GET/api/v1/tools/available

This endpoint is in beta. Its request and response may change.

Lists every tool that a user's connected accounts can call, across all their connections. identifier is required. To narrow the list to chosen connections, providers or tools, use List a user's scoped tools.

This page as markdown Tools overview

Authorization

Authorization: Bearer $TOKEN, an access token from the client credentials grant. See Authentication.

Query parameters

identifierstringrequired

Your app's ID for the user, the same value you used when the user connected. Use a stable internal ID, not an email address.

page_sizeinteger

Maximum number of tools to return per page

page_tokenstring

Token from a previous response for pagination

scalekit.tools.listAvailableTools

Lists tools that are available for a specific connected account identifier. Returns every tool the user's connected accounts can call, not only the ones you pass to your agent.

scalekit.tools.listAvailableTools(
  identifier: string,
  options?: {
    pageSize?: number;
    pageToken?: string;
  },
): Promise<ListAvailableToolsResponse>

Parameters

identifierstringrequired

Your app's ID for the user, the same value you used when the user connected. Use a stable internal ID, not an email address.

pageSizenumber

Maximum number of tools to return per page.

pageTokenstring

Token from a previous listAvailableTools response for pagination.

Returns Promise<ListAvailableToolsResponse>.

From @scalekit-sdk/node 2.18.0.

Response 200

next_page_tokenstring

Token for fetching the next page of tools

prev_page_tokenstring

Token for fetching the previous page of tools

toolsarray of object

List of tools available for the identifier

Show 7 child attributes

definitionobject

Tool definition in structured format

idstring

Unique ID of the tool. Immutable and read-only.

is_defaultboolean

Marks this tool as the default version for the combination. Read-only.

metadataobject

Additional metadata about the tool

providerstring

Provider name (e.g. GOOGLE). Read-only.

tagsarray of string

Tags for categorization or filtering

updated_atstring

Timestamp when the tool was last updated. Read-only.

total_sizeinteger

Total number of available tools matching the query

Errors

Every error has the same body: code, message and details. See Errors and rate limits.

400Invalid request - missing or malformed identifier

401Authentication required - missing or invalid access token

404Identifier not found

Request

curl -sS -G -X GET \
  "$SCALEKIT_ENVIRONMENT_URL/api/v1/tools/available" \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode "identifier=user_123" \
  --data-urlencode "page_size=2"

1
import os
2

3
import requests
4

5
env_url = os.environ["SCALEKIT_ENVIRONMENT_URL"]
6
token = requests.post(
7
    f"{env_url}/oauth/token",
8
    data={
9
        "grant_type": "client_credentials",
10
        "client_id": os.environ["SCALEKIT_CLIENT_ID"],
11
        "client_secret": os.environ["SCALEKIT_CLIENT_SECRET"],
12
    },
13
).json()["access_token"]
14

15
response = requests.get(
16
    f"{env_url}/api/v1/tools/available",
17
    headers={"Authorization": f"Bearer {token}"},
18
    params={"identifier": "user_123", "page_size": 2},
19
)
20
response.raise_for_status()
21
result = response.json()

const result = await scalekit.tools.listAvailableTools("user_123", {
  pageSize: 2,
});

Response 200

1
{
2
  "tools": [
3
    {
4
      "id": "tol_86147403291582051",
5
      "provider": "GMAIL",
6
      "definition": {
7
        "name": "gmail_fetch_mails",
8
        "description": "Fetch emails from a connected Gmail account using search filters. Requires a valid Gmail OAuth2 connection.",
9
        "schema_version": "1",
10
        "tool_version": "1",
11
        "input_schema": {
12
          "type": "object",
13
          "properties": {
14
            "query": {
15
              "type": [
16
                "string",
17
                "null"
18
              ],
19
              "description": "Search query string using Gmail's search syntax (e.g., 'is:unread from:user@example.com')"
20
            },
21
            "max_results": {
22
              "type": [
23
                "integer",
24
                "null"
25
              ],
26
              "description": "Maximum number of emails to fetch"
27
            }
28
          }
29
        }
30
      },
31
      "is_default": true,
32
      "metadata": {},
33
      "tags": []
34
    },
35
    {
36
      "id": "tol_86147403291583327",
37
      "provider": "GMAIL",
38
      "definition": {
39
        "name": "gmail_send_message",
40
        "description": "Send an email message immediately from the authenticated Gmail account. Constructs a MIME message and sends it via the Gmail API.",
41
        "schema_version": "1",
42
        "tool_version": "1",
43
        "input_schema": {
44
          "type": "object",
45
          "properties": {
46
            "to": {
47
              "type": "string",
48
              "description": "The recipient email address(es) for the message."
49
            },
50
            "subject": {
51
              "type": "string",
52
              "description": "The subject line of the email."
53
            },
54
            "body": {
55
              "type": "string",
56
              "description": "The body content of the email."
57
            }
58
          },
59
          "required": [
60
            "to",
61
            "subject",
62
            "body"
63
          ]
64
        }
65
      },
66
      "is_default": true,
67
      "metadata": {},
68
      "tags": []
69
    }
70
  ],
71
  "next_page_token": "eyJhZnRlciI6InRvbF84NjE0NzQwMzI5MTU4MzMyNyJ9",
72
  "prev_page_token": "",
73
  "total_size": 48
74
}