Skip to main content
POST
/
api
/
v1
/
users
/
me
/
export
Request Export
curl --request POST \
  --url https://roughy-api-staging.fly.dev/api/v1/users/me/export \
  --header 'Authorization: Bearer <token>'
{
  "created_at": "2026-05-02T08:54:52.423000Z",
  "id": "019de7f7-f656-7c82-829d-0716a3ba35d4",
  "payload": {
    "expires_at": "2026-05-09T08:54:52.423000Z",
    "size_bytes": 4823572,
    "status": "ready",
    "storage_path": "exports/019de7dd-d3cd-7d42-886e-ac55f552b3fb/2026-05-02.zip"
  },
  "type": "data_export_ready"
}

Documentation Index

Fetch the complete documentation index at: https://docs.roughy.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Either your Supabase session JWT (UI flows) or an API key minted via POST /api-keys (programmatic flows). Pass it as Authorization: Bearer <token>. The server inspects the token format and routes to JWT or API-key verification automatically.

Response

202 - application/json

Successful Response

API projection of a data_export_ready-type notification.

Used by POST /api/v1/users/me/export (returns 202 with this body) -- the typed payload lets the frontend render the right state variant straight from the discriminated union.

id
string<uuid>
required
type
string
required
Allowed value: "data_export_ready"
payload
DataExportPendingPayload · object
required

Export requested; arq job not yet started or in flight.

Example:
{
  "requested_at": "2026-05-02T08:54:52.423000Z",
  "status": "pending"
}
created_at
string<date-time>
required
read_at
string<date-time> | null
required