OMomniapp
Apps

Get app download status

Changed on

Poll until status is complete or error. A job is visible only to the user it runs as, so pass the same userId the job was started with.

get/api/v1/apps/{identifier}/download/{jobId}/status

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/apps/{identifier}/download/{jobId}/status
  • Auth
    HTTP bearer

Path parameters

identifierstring required

The identifier (short ID or UUID) of a published document that presents as an app.

Example:12db1a0a
jobIdstring uuid required

Download job ID returned by the initiate call

Example:123e4567-e89b-12d3-a456-426614174000

Query parameters

userIdstring uuid

Target user ID (for org-scoped API keys)

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

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