export_model

Queue a portable .btx archive export for a Bridge Town model. Poll get_export(job_id) for completion and the pre-signed download URL. Returns: job_id (str) — export job UUID; status (str) — queued/pending status; model_name (str) — model slug; message (str) — next action; warning (str|null) — optional clamping or staging warning.

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='UUID or name of the model to export.')]	Yes	—
include_runs	Annotated[int, Field(description='When true, include model run history in the export archive.')]	No	5
include_dashboards	Annotated[bool, Field(description='When true, include dashboard configurations in the export archive.')]	No	True

Returns

Returns a structured object. Top-level fields:

• job_id (string)
• status (string)
• model_name (string)
• message (string)
• warning (null)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "export_model",
  "arguments": {
    "model_name": "forecasts",
    "include_runs": 5,
    "include_dashboards": true
  }
}

Response

{
  "job_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
  "status": "queued",
  "model_name": "forecasts",
  "message": "Export queued.",
  "warning": null
}

Notes

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