Skip to content

get_export

Poll a .btx export job by job_id. When the job has completed successfully the response includes a pre-signed download_url and download_url_expires_at (UTC, ISO-8601). Issuing the URL emits a synchronous SOC2 audit event; if the audit subsystem is unavailable the tool refuses to surface the URL.

read-only · idempotent

NameTypeRequiredDefaultDescription
job_idstrYes

Returns a structured object. Top-level fields:

  • job_id (string)
  • status (string)
  • project_id (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)

See the response example below for the full payload shape.

{
"name": "get_export",
"arguments": {
"job_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
}
}
{
"job_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"status": "success",
"project_id": "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"
}
  • Module: Exports
  • Requires authentication via API token or Auth0 JWT.