Skip to main content
Fetch Tools
curl --request GET \
  --url https://{api_endpoint}/api/v1/tools \
  --header 'Authorization: Bearer <token>'
[
  {
    "description": "<string>",
    "name": "<string>",
    "permission": "read_only",
    "display_name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "<string>",
    "tenant_name": "<string>",
    "title": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "created_by_username": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "tags": [
      "<unknown>"
    ],
    "input_schema": {
      "type": "object",
      "properties": {},
      "required": []
    },
    "output_schema": {
      "type": "object",
      "description": "<string>",
      "properties": {},
      "items": {
        "type": "string",
        "title": "<string>",
        "description": "<string>",
        "properties": {},
        "required": [
          "<string>"
        ],
        "items": "<unknown>",
        "default": "<unknown>",
        "enum": [
          "<unknown>"
        ],
        "minimum": 123,
        "maximum": 123,
        "minLength": 123,
        "maxLength": 123,
        "pattern": "<string>",
        "format": "<string>",
        "in": "query",
        "aliasName": "<string>",
        "anyOf": [
          "<unknown>"
        ],
        "oneOf": [
          "<unknown>"
        ],
        "allOf": [
          "<unknown>"
        ]
      },
      "required": [],
      "format": "<string>",
      "anyOf": [
        "<unknown>"
      ],
      "oneOf": [
        "<unknown>"
      ],
      "allOf": [
        "<unknown>"
      ]
    },
    "binding": {
      "openapi": {
        "http_method": "GET",
        "http_path": "<string>",
        "security": [],
        "servers": [],
        "connection_id": "<string>",
        "callback": {
          "callback_url": "<string>",
          "method": "GET",
          "output_schema": {
            "type": "object",
            "description": "<string>",
            "properties": {},
            "items": {
              "type": "string",
              "title": "<string>",
              "description": "<string>",
              "properties": {},
              "required": [
                "<string>"
              ],
              "items": "<unknown>",
              "default": "<unknown>",
              "enum": [
                "<unknown>"
              ],
              "minimum": 123,
              "maximum": 123,
              "minLength": 123,
              "maxLength": 123,
              "pattern": "<string>",
              "format": "<string>",
              "in": "query",
              "aliasName": "<string>",
              "anyOf": [
                "<unknown>"
              ],
              "oneOf": [
                "<unknown>"
              ],
              "allOf": [
                "<unknown>"
              ]
            },
            "required": [],
            "format": "<string>",
            "anyOf": [
              "<unknown>"
            ],
            "oneOf": [
              "<unknown>"
            ],
            "allOf": [
              "<unknown>"
            ]
          },
          "input_schema": {
            "type": "object",
            "properties": {},
            "required": []
          }
        },
        "acknowledgement": {
          "output_schema": {
            "type": "object",
            "description": "<string>",
            "properties": {},
            "items": {
              "type": "string",
              "title": "<string>",
              "description": "<string>",
              "properties": {},
              "required": [
                "<string>"
              ],
              "items": "<unknown>",
              "default": "<unknown>",
              "enum": [
                "<unknown>"
              ],
              "minimum": 123,
              "maximum": 123,
              "minLength": 123,
              "maxLength": 123,
              "pattern": "<string>",
              "format": "<string>",
              "in": "query",
              "aliasName": "<string>",
              "anyOf": [
                "<unknown>"
              ],
              "oneOf": [
                "<unknown>"
              ],
              "allOf": [
                "<unknown>"
              ]
            },
            "required": [],
            "format": "<string>",
            "anyOf": [
              "<unknown>"
            ],
            "oneOf": [
              "<unknown>"
            ],
            "allOf": [
              "<unknown>"
            ]
          }
        }
      },
      "python": {
        "function": "<string>",
        "requirements": [
          "<string>"
        ],
        "connections": {}
      },
      "wxflows": {
        "endpoint": "<string>",
        "flow_name": "<string>",
        "security": []
      },
      "skill": {
        "skillset_id": "<string>",
        "skill_id": "<string>",
        "skill_operation_path": "<string>",
        "http_method": "GET"
      },
      "client_side": {},
      "conversational_search": {
        "conversational_search_config": {},
        "connections": [
          "<unknown>"
        ],
        "version": "0.0.1"
      },
      "mcp": {
        "server_url": "<string>",
        "source": "public-registry",
        "env": {},
        "command": "<string>",
        "args": [
          "<string>"
        ],
        "transport": "<string>",
        "connections": {}
      },
      "flow": {
        "http_method": "GET",
        "http_path": "<string>",
        "security": [],
        "servers": [],
        "connection_id": "<string>",
        "callback": {
          "callback_url": "<string>",
          "method": "GET",
          "output_schema": {
            "type": "object",
            "description": "<string>",
            "properties": {},
            "items": {
              "type": "string",
              "title": "<string>",
              "description": "<string>",
              "properties": {},
              "required": [
                "<string>"
              ],
              "items": "<unknown>",
              "default": "<unknown>",
              "enum": [
                "<unknown>"
              ],
              "minimum": 123,
              "maximum": 123,
              "minLength": 123,
              "maxLength": 123,
              "pattern": "<string>",
              "format": "<string>",
              "in": "query",
              "aliasName": "<string>",
              "anyOf": [
                "<unknown>"
              ],
              "oneOf": [
                "<unknown>"
              ],
              "allOf": [
                "<unknown>"
              ]
            },
            "required": [],
            "format": "<string>",
            "anyOf": [
              "<unknown>"
            ],
            "oneOf": [
              "<unknown>"
            ],
            "allOf": [
              "<unknown>"
            ]
          },
          "input_schema": {
            "type": "object",
            "properties": {},
            "required": []
          }
        },
        "acknowledgement": {
          "output_schema": {
            "type": "object",
            "description": "<string>",
            "properties": {},
            "items": {
              "type": "string",
              "title": "<string>",
              "description": "<string>",
              "properties": {},
              "required": [
                "<string>"
              ],
              "items": "<unknown>",
              "default": "<unknown>",
              "enum": [
                "<unknown>"
              ],
              "minimum": 123,
              "maximum": 123,
              "minLength": 123,
              "maxLength": 123,
              "pattern": "<string>",
              "format": "<string>",
              "in": "query",
              "aliasName": "<string>",
              "anyOf": [
                "<unknown>"
              ],
              "oneOf": [
                "<unknown>"
              ],
              "allOf": [
                "<unknown>"
              ]
            },
            "required": [],
            "format": "<string>",
            "anyOf": [
              "<unknown>"
            ],
            "oneOf": [
              "<unknown>"
            ],
            "allOf": [
              "<unknown>"
            ]
          }
        },
        "flow_id": "",
        "version": "TIP",
        "dependencies": {
          "tools": [],
          "agents": []
        },
        "model": {}
      },
      "langflow": {
        "langflow_id": "<string>",
        "project_id": "<string>",
        "langflow_version": "<string>",
        "connections": {}
      }
    },
    "uid": "<string>",
    "collab_idf": "<string>",
    "environment_id": "<string>",
    "toolkit_id": "<string>",
    "is_async": false,
    "restrictions": "editable",
    "bundled_agent_id": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
ids
string[] | null
​
show_bundled
boolean
default:false
​
names
string[] | null

Response

Successful Response

​
description
string
required
​
name
string
required
​
permission
enum<string>
required

The permission level required to use this tool.

Available options:
read_only,
write_only,
read_write,
admin
​
display_name
string
required
​
id
string<uuid> | null
​
tenant_id
string | null
​
tenant_name
string | null
​
title
string | null
​
created_on
string<date-time> | null
​
created_by
string | null
​
created_by_username
string | null
​
updated_at
string<date-time> | null
​
tags
any[] | null
​
input_schema
ToolRequestBody · object

A request body for a tool.

​
output_schema
ToolResponseBody · object

A response body for a tool.

​
binding
ToolBinding · object

A binding of the tool to a specific runtime environment such as an OpenAPI endpoint or local Python function.

​
uid
​
collab_idf
​
environment_id
​
toolkit_id
​
is_async
boolean
default:false

Whether the tool execution is asynchronous

​
restrictions
string | null
default:editable

Whether the tool is editable or not

​
bundled_agent_id