Skip to main content
GET
/
workflows
/
v1
/
tools
Get Tools
curl --request GET \
  --url https://api-qa.interactly.ai/workflows/v1/tools \
  --header 'Authorization: Bearer <token>'
{
  "tools": [
    {
      "team_id": "<string>",
      "created_by": "<string>",
      "updated_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "_id": "5eb7cf5a86d9755df3a6c593",
      "tool_config": {
        "logical_id": "<string>",
        "tool_id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "category": "<string>",
        "signature": "<string>",
        "args_schema": {},
        "static_messages_config": {
          "static_messages": [
            "<string>"
          ],
          "static_messages_selection_mode": "random"
        },
        "result_runtime_variable_name": "tool_result",
        "type": "inline_python",
        "code": "<string>"
      }
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Query Parameters

filters
ToolsFilter · object
required
size
integer
default:100

Number of items per page

Required range: x >= 1
page
integer
default:1

Page number

Required range: x >= 1
search
string | null

Search keywords

start
string<date-time> | null

Filter by start time (ISO 8601 format)

end
string<date-time> | null

Filter by end time (ISO 8601 format)

Response

Successful Response

Response model for a list of tools. Contains a list of ToolsModel objects.

tools
ToolsModel · object[]

List of tools

total
integer | null

Total number of tools available without pagination.