OMomni
App downloads

Get app download status

Changed on

Poll the status of an app download job started by Initiate app download. Poll until status is complete, then fetch the file from Get app download file.

get/v1/apps/{documentId}/download/{jobId}/status

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/apps/{documentId}/download/{jobId}/status
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

documentIdstring required
Example:12db1a0a

The document's URL slug (e.g. abc123) or its canonical workbook UUID.

jobIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

The job ID returned by Initiate app download.

Query parameters

userIdstring uuid

Organization API key required. The membership ID of the user to act as.

Response

Download job status.

created_atstring required

When the job was created (ISO 8601)

errorstring

Why the job failed. Present only when status is error.

format'link_only' | 'pdf' | 'png' | 'csv' | 'xlsx' | 'json' | 'ai_prompt' | 'ai_summary_text'

Output format. Omitted when status is error.

job_idstring

Download job ID. Omitted when status is error.

status'in_progress' | 'complete' | 'error' required

Current status of the download job:

  • in_progress while the app renders
  • complete once the file can be fetched
  • error if the job failed

Example response

{
  "created_at": "2026-10-13T18:30:00.000Z",
  "format": "png",
  "status": "complete"
}

Changes