INinteractly
Tools

Export Tool

Changed on

Export a saved custom tool as a self-describing JSON bundle.

Identity/audit fields are stripped and secret-bearing fields (external_api headers/body) are redacted; the recipient re-supplies them on import. Inbuilt tools are not exportable.

get/workflows/v1/tools/{tool_id}/export

Request

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

Path parameters

tool_idstring required

Response

Successful Response

export_formatstring

Export format identifier

source_tool_idstring nullable

Original tool _id

source_tool_namestring nullable

Original tool name

tool_typestring nullable

ToolType of the exported tool (discriminator)

tool_configobject required

Sanitized ToolConfig as a dict (identity fields stripped, secrets redacted)

required_dynamic_variablesstring[]

Names of the dynamic/global variables this tool references. Values are team-scoped and are not carried in the bundle, so the importing team must define each name before the tool runs.

exported_atstring date-time

Timestamp of export

warningsstring[]

Non-fatal notes (team-scoped refs cleared, env-specific endpoint, raw api_body, etc.)

Changes