---
title: "Initiate app download"
method: POST
path: "/api/v1/apps/{identifier}/download"
tags: ["Apps"]
---

# Initiate app download

`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

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.

## Path parameters

- `identifier` string, required: The identifier (short ID or UUID) of a published document that presents as an app.

## Query parameters

- `userId` string, uuid: Target user ID (for org-scoped API keys)

## Request body

- AppsDownloadBody
  - `filename` string: 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).

## Response `200`

Download job initiated successfully

- AppsDownloadResponse
  - `job_id` string, uuid, required: ID of the download job. Use this to poll for download status.
  - `message` string, required: Status message

## Other responses

- `400`: Invalid request body
- `401`: Authentication required
- `403`: Permission denied - apps or app downloads are not enabled, or the user cannot download this app
- `404`: App not found, or not published
- `409`: Download already in progress for this app
- `500`: Failed to initiate download

## Changes

- **2026-10-15** `ce27cb678f05`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/omniapp/apis/omni-api/changes/api/v1/apps/:identifier/download/post.md)

---

[API](https://skmtc.dev/omniapp/apis/omni-api.md) - [All operations](https://skmtc.dev/omniapp/apis/omni-api/llms.txt) - [OpenAPI document](https://skmtc.dev/omniapp/apis/omni-api/revisions/76b40ebc2292?raw)