Skip to documentation
Browse documentation

Create a bounded asynchronous export

Use exports for larger, repeatable extracts that should not hold an API request open. V1 writes CSV to private Vercel Blob storage and returns a short-lived API download URL only after the job completes.

Create an export

curl --request POST https://api.data.hyran.co/v1/exports \
  --header "Authorization: Bearer $HYRAN_DATA_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "resource": "bom_yield_changes",
    "format": "csv",
    "filters": {
      "from": "2026-07-31",
      "to": "2026-08-31",
      "changeType": "changed"
    }
  }'

The API returns 202 Accepted with an export job. Poll GET /v1/exports/{exportId} using bounded backoff until its status is completed or failed.

Download the result

When the job is complete, follow its downloadUrl with the same bearer credential. The API streams the private object only after rechecking the verified tenant context and job ownership.

Parquet is reserved in the contract but is not available in V1. Use CSV until the TypeScript writer passes Vercel load and compatibility validation.