curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/apps/{documentId}/download \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "format": "png"
}
'

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

{
  "detail": "<string>",
  "status": 400
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "detail": "<string>",
  "status": 403
}

{
  "detail": "<string>",
  "status": 404
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "detail": "A download is already in progress for this app. Please wait for it to complete or check its status.",
  "existing_job_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "RENDERING"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

Downloads

Initiate app download

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

apps

{documentId}

download

curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/apps/{documentId}/download \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "format": "png"
}
'

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

{
  "detail": "<string>",
  "status": 400
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "detail": "<string>",
  "status": 403
}

{
  "detail": "<string>",
  "status": 404
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "detail": "A download is already in progress for this app. Please wait for it to complete or check its status.",
  "existing_job_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "RENDERING"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

documentId

string

required

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

Example:

"12db1a0a"

Query Parameters

userId

string<uuid>

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

Body

application/json

format

enum<string>

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

Available options:

png,

pdf,

xlsx,

csv

Example:

"png"

filename

string

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

Required string length: 1 - 255

Example:

"territory-planner"

Response

Download job initiated successfully.

job_id

string<uuid>

required

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

Example:

"123e4567-e89b-12d3-a456-426614174000"

message

string

required

Status message

Example:

"Download initiated successfully"

Getting started

Who am I?

Administration APIs

AI APIs

App APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Embed APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Initiate app download

Authorizations

Path Parameters

Query Parameters

Body

Response