OMomni
App downloads

Initiate app download

Changed on

Start an asynchronous download job for a published app, rendered headlessly the same way a scheduled app delivery renders it. Every query in the app's workbook runs, including linked tabs; queries on a model the downloading user cannot query are omitted. Only the app's default view is rendered.

After starting a job, poll Get app download status for completion, then retrieve the file from Get app download file.

Only one download per app, per user is allowed at a time. If a download is already in progress, the request returns a 409 Conflict response with the existing job ID.

post/v1/apps/{documentId}/download

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/apps/{documentId}/download
  • 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.

Query parameters

userIdstring uuid

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

Request body

filenamestring

Custom filename for the downloaded file, without extension. Defaults to the app name.

format'png' | 'pdf' | 'xlsx' | 'csv' required

Specifies the output format:

  • png - A screenshot of the rendered app
  • pdf - The rendered app as one page
  • xlsx - A screenshot cover sheet plus one sheet per query
  • csv - A ZIP of one CSV per query

Example request

{
  "filename": "territory-planner",
  "format": "png"
}

Response

Download job initiated successfully.

job_idstring uuid required

ID of the download job. Use this to poll for status and fetch the file.

messagestring required

Status message

Example response

{
  "job_id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "Download initiated successfully"
}

Changes