INinteractly
Tools

Import Tool

Changed on

Create a new tool from an exported bundle (see GET /tools/{tool_id}/export).

Re-injects redacted secrets from secret_overrides, resolves non-portable references, assigns a fresh identity to the importing team, and persists through the same validation path as create_tool.

post/workflows/v1/tools/import

Request

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

Request body

name_overridestring nullable

Override for the imported tool's name

secret_overridesobject

Dotted-path -> value for each redacted field being re-supplied, e.g. {'api_headers.Authorization': 'Bearer ...'}

clear_unresolved_refsboolean

Clear team-scoped refs (KB ids) that cannot resolve in the importing team

confirm_executableboolean

Required True to import an inline_python tool (executable code)

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