get_transfer

Poll a .btx export or import job by job_id (bt-p1opf.8: merges the former get_export and get_import tools). Pass kind=‘export’ for a job returned by export_model, or kind=‘import’ for one returned by import_model — export and import jobs live in separate tables, so a bare job_id does not itself say which kind it is.

read-only · idempotent

Parameters

Name	Type	Required	Default	Description
job_id	Annotated[str, Field(description='UUID of the transfer job to check.')]	Yes	—
kind	Annotated[str, Field(description="Which kind of transfer job job_id refers to: 'export' or 'import'.")]	Yes	—
workspace_id	`Annotated[str	None, Field(description=ID_BACKED_WORKSPACE_ID_FIELD_DESCRIPTION)]`	No	None

Returns

Returns a structured object. Top-level fields:

• job_id (string)
• status (string)
• kind (string)
• model_name (string)
• archive_size_bytes (integer)
• download_url (string)
• download_url_expires_at (string)
• error_message (null)
• created_at (string)
• started_at (string)
• finished_at (string)
• workspace_id (string)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "get_transfer",
  "arguments": {
    "job_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
    "kind": "export"
  }
}

Response

{
  "job_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
  "status": "success",
  "kind": "export",
  "model_name": "forecasts",
  "archive_size_bytes": 184320,
  "download_url": "https://storage.example.com/exports/forecasts.btx?signature=...",
  "download_url_expires_at": "2026-04-28T11:00:00+00:00",
  "error_message": null,
  "created_at": "2026-04-28T10:00:00+00:00",
  "started_at": "2026-04-28T10:00:05+00:00",
  "finished_at": "2026-04-28T10:00:18+00:00",
  "workspace_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}

Notes

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