OMomniapp
Apps

Initiate app download

Changed on

Renders the published app headlessly, as the user the download runs as (the target user when one is named, else the API key’s user), and stores the result for retrieval. Every query in the app’s workbook runs; queries on a model that user cannot query are omitted.

post/api/v1/apps/{identifier}/download

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
  • Auth
    HTTP bearer

Path parameters

identifierstring required

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

Example:12db1a0a

Query parameters

userIdstring uuid

Target user ID (for org-scoped API keys)

Request body

filenamestring

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

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

Output format: png (screenshot of the rendered app), pdf (the rendered app as one page), xlsx (a screenshot cover sheet plus one sheet per query), or 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 download status.

messagestring required

Status message

Example response

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

Changes