---
title: "Create a download resource"
method: POST
path: "/v0/catalogs/download"
tags: ["Catalog"]
---

# Create a download resource

`POST /v0/catalogs/download`

## Request

- Base URL: `https://api.pixxel.space`
- URL: `https://api.pixxel.space/v0/catalogs/download`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/pixxel/apis/stargate/docs/v0/catalogs/download/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a download resource which will get populated with a signed url async. Only one of orderitem or catalog id should be populated in a single request.

## Request body

- ClerkDownloadRequest
  - `catalog_ids` string[], required: do not supply order_item_ids if this field is used
  - `order_item_ids` string[], required: do not supply catalog_ids if this field is used

## Response `201`

Created

- ClerkDownloadResponse
  - `id` string
  - `signed_url` string
  - `status` 'success' | 'created' | 'failed' | 'in_progress'

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `500`: Internal Server Error

---

[API](https://skmtc.dev/pixxel/apis/stargate.md) - [All operations](https://skmtc.dev/pixxel/apis/stargate/llms.txt) - [OpenAPI document](https://skmtc.dev/pixxel/apis/stargate/revisions/519562bd9d7a?raw)