Data Export

Poll the status of a workspace export job

Returns the current lifecycle state of an export job. When status is completed, download_url is populated with a signed URL that remains valid until download_expires_at.

Caller must be a member of the workspace (any role).

get/api/workspaces/{workspace}/export/{job_id}

Request

  • Base URL: https://www.audioscrape.com
  • URL: https://www.audioscrape.com/api/workspaces/{workspace}/export/{job_id}
  • Auth: HTTP bearer

Path parameters

workspaceinteger required

Workspace ID

job_idinteger required

Export job ID returned by POST /api/workspaces/{workspace}/export

Response

Current status of the export job

bytesinteger nullable

Total size of the generated archive in bytes. null until completion.

completed_atstring nullable

RFC 3339 UTC timestamp the job reached a terminal state. null while in flight.

created_atstring nullable

RFC 3339 UTC timestamp the job was created.

download_expires_atstring nullable

RFC 3339 UTC timestamp at which download_url stops working.

download_urlstring nullable

Signed download URL. Present only when status == "completed".

error_messagestring nullable

Human-readable failure reason. Set only when status == "failed".

idinteger required

Numeric job ID.

item_countinteger nullable

Number of items packaged in the export. null until completion.

statusstring required

One of queued, running, completed, failed, expired.

Example response

{
  "bytes": 1572864000,
  "completed_at": "2026-05-17T10:42:00Z",
  "created_at": "2026-05-17T10:00:00Z",
  "download_expires_at": "2026-05-24T10:42:00Z",
  "download_url": "https://files.audioscrape.com/exports/abc.tar.gz?sig=...",
  "error_message": "S3 upload timed out",
  "id": 42,
  "item_count": 1234,
  "status": "completed"
}

Changes

No recorded changes to this operation across all 1 revision of this API.