INinteractly
Tools

Clone Tool Endpoint

Changed on

Duplicate a saved custom tool within the caller's team.

Unlike export/import, the config is copied verbatim — secrets included — because source and copy live in the same team. The copy gets a fresh _id and logical_id and is named "<source> (Clone)" unless the body supplies a name. Plain inbuilt tools cannot be cloned; configurable inbuilt instances can, since those are real documents of this team's own.

post/workflows/v1/tools/{tool_id}/clone

Request

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

Path parameters

tool_idstring required

Request body

namestring nullable

Name for the cloned tool. Defaults to '<source tool name> (Clone)'.

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