INinteractly
Tools

Get Tool

Changed on

Endpoint to retrieve a tool configuration by its ID. Checks both custom tools in the database and inbuilt tools from the registry.

get/workflows/v1/tools/{tool_id}

Request

  • Base URL
    https://api-qa.interactly.ai
  • URL
    https://api-qa.interactly.ai/workflows/v1/tools/{tool_id}
  • Auth
    HTTP bearer

Path parameters

tool_idstring required

Response

Successful Response

warningsstring[]

Advisory notes: the write succeeded, but the config will not work yet — e.g. an imported tool whose dynamic variables this team has not defined.

Example response

{
  "tool": {
    "_id": "5eb7cf5a86d9755df3a6c593"
  }
}

Changes

  • 4a885f58a270Revision changes
    • breaking

      added to the // response property oneOf list for the response status

    • info

      mapped value for discriminator key external_api changed from to for // response property for the response status

    • info

      removed from the // response property oneOf list for the response status

  • 313ea3ccd136Revision changes
    • info

      added the optional property //// to the response with the status