import_project

Import a Bridge Town project from a .btx archive file. Returns a job_id for polling via get_import.

Parameters

Name	Type	Required	Default	Description
archive_path_or_url	str	Yes	—
target_workspace_id	`str	None`	No	None
options	`dict[str, Any]	None`	No	None

Returns

Returns a structured object. Top-level fields:

• job_id (string)
• status (string)
• target_workspace_id (string)
• target_repo_name (string)
• message (string)
• duplicate_of (null)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "import_project",
  "arguments": {
    "archive_path_or_url": "s3://imports/forecasts.btx",
    "target_workspace_id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
    "options": {
      "repo_name": "forecasts-imported",
      "conflict_policy": "fail",
      "idempotency_key": "forecasts-import-20260428"
    }
  }
}

Response

{
  "job_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
  "status": "queued",
  "target_workspace_id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
  "target_repo_name": "forecasts-imported",
  "message": "Import queued.",
  "duplicate_of": null
}

Notes

• Module: Imports
• Requires authentication via API token or Auth0 JWT.