Export API overview

Use the Export API to create export jobs and download results when ready.

Export API overview

Use the Export API to create export jobs and download results when ready.

This page is consumer-facing. Internal annotations and worker details are intentionally omitted. Canonical contract: ../../internal/system-design/api-specs/export-api.yaml (derive/curate; do not duplicate endpoint lists by hand).

Authentication

Use a bearer access token with the export:write and export:read scopes.

Authorization: Bearer <token>

Mental model

1. POST /v1/exports creates a job and returns 202 with a job_id.
2. Poll GET /v1/exports/{job_id} until status is completed or failed.
3. Download via the download_url on completion (time-limited).

sequenceDiagram
  participant Client
  participant API
  Client->>API: POST /v1/exports
  API-->>Client: 202 job_id
  loop Until completed
    Client->>API: GET /v1/exports/job_id
    API-->>Client: status
  end
  Client->>API: GET download_url

Webhooks

Configure a webhook endpoint in the dashboard to receive POST notifications when exports complete or fail. Each payload carries a job_id and status.

See tutorial: Schedule automated exports for configuration steps.

Errors (common)

Related

• Product quickstart: ../getting-started/quickstart.md
• Shared terms: ../../shared/glossary.md