GET
/
v2
/
tools
Fetch Tools
curl --request GET \
  --url http://{api_endpoint}/api/v1/v2/tools \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tenant_id": "<string>",
      "tenant_name": "<string>",
      "title": "<string>",
      "description": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "created_by_username": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "tags": [
        "<any>"
      ],
      "name": "<string>",
      "permission": "read_only",
      "input_schema": {
        "type": "object",
        "properties": {},
        "required": [
          "<string>"
        ]
      },
      "output_schema": {},
      "binding": {
        "openapi": {
          "http_method": "GET",
          "http_path": "<string>",
          "security": [
            {
              "type": "<any>",
              "scheme": "<any>",
              "in": "<any>",
              "name": "<any>",
              "description": "<any>",
              "open_id_connect_url": "<any>",
              "flows": "<any>"
            }
          ],
          "servers": [
            "<string>"
          ],
          "connection_id": "<string>",
          "callback": {
            "callback_url": "<string>",
            "method": "GET",
            "input_schema": {},
            "output_schema": {}
          },
          "acknowledgement": {
            "output_schema": {}
          }
        },
        "python": {
          "function": "<string>",
          "requirements": [
            "<string>"
          ],
          "connections": {}
        },
        "wxflows": {
          "endpoint": "<string>",
          "flow_name": "<string>",
          "security": {
            "type": "<any>",
            "scheme": "<any>",
            "in": "<any>",
            "name": "<any>",
            "description": "<any>",
            "open_id_connect_url": "<any>",
            "flows": "<any>"
          }
        },
        "skill": {
          "skillset_id": "<string>",
          "skill_id": "<string>",
          "skill_operation_path": "<string>",
          "http_method": "GET"
        },
        "client_side": {},
        "conversational_search": {
          "conversational_search_config": {},
          "connections": [
            "<any>"
          ],
          "version": "<string>"
        },
        "mcp": {
          "server_url": "<string>",
          "source": "public-registry",
          "env": {},
          "command": "<string>",
          "args": [
            "<string>"
          ],
          "connections": {}
        },
        "flow": {
          "http_method": "GET",
          "http_path": "<string>",
          "security": [
            {
              "type": "<any>",
              "scheme": "<any>",
              "in": "<any>",
              "name": "<any>",
              "description": "<any>",
              "open_id_connect_url": "<any>",
              "flows": "<any>"
            }
          ],
          "servers": [
            "<string>"
          ],
          "connection_id": "<string>",
          "callback": {
            "callback_url": "<string>",
            "method": "GET",
            "input_schema": {},
            "output_schema": {}
          },
          "acknowledgement": {
            "output_schema": {}
          },
          "flow_id": "<string>",
          "version": "<string>",
          "dependencies": {
            "tools": [
              "<any>"
            ],
            "agents": [
              "<any>"
            ]
          },
          "model": {}
        }
      },
      "display_name": "<string>",
      "uid": "<string>",
      "collab_idf": "<string>",
      "environment_id": "<string>",
      "toolkit_id": "<string>",
      "is_async": false
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123,
  "result_count": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ids
string[] | null
toolkit_ids
string[] | null
names
string[] | null
query
string | null

Search by name and description

limit
integer | null

Limit the number of results returned

Required range: x >= 1
offset
integer | null

Skip the first N results

Required range: x >= 0
sort
enum<string> | null
default:asc

Sort by name and recently added (recent/asc/desc)

Available options:
asc,
desc,
recent

Response

200
application/json

Successful Response

The response is of type object.