Skip to main content
GET
/
workflows
/
v1
/
tools
/
{tool_id}
Get Tool
curl --request GET \
  --url https://api-qa.interactly.ai/workflows/v1/tools/{tool_id} \
  --header 'Authorization: Bearer <token>'
{
  "tool": {
    "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>"
    }
  }
}

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

tool_id
string
required

Response

Successful Response

Response model for a single tool. Contains a ToolsModel object.

tool
ToolsModel · object
required

Single tool object