---
title: "Initiate a download"
method: POST
path: "/download-requests"
---

# Initiate a download

`POST /download-requests`

## Request

- Base URL: `http://localhost:6286`
- URL: `http://localhost:6286/download-requests`
- Auth: none declared
- TypeScript: <https://skmtc.dev/iconik/apis/agent-api/docs/download-requests/post.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `open_in_fcp` string
- `resolve_on_local_isg` string

## Headers

- `app-id` string
- `iconik-host` string
- `auth-token` string
- `share-auth-token` string
- `share-hash` string

## Request body

- DownloadRequestBody
  - `assets` object[]
    - `assetId` string, required
    - `format` string, required
    - `outputPath` string
  - `collections` object[]
    - `collectionId` string, required
    - `format` string, required
  - `playlists` object[]
    - `playlistId` string, required
    - `format` string, required
  - `fileSets` object[]
    - `fileSetId` string, required
    - `assetId` string, required
  - `assetVersions` object[]
    - `versionId` string, required
    - `assetId` string, required
    - `format` string, required
  - `files` object[]
    - `assetId` string, required
    - `fileId` string, required
    - `outputPath` string

## Response `200`

Response when adding a download request

- DownloadRequest[]: Response when adding a download request
  - `id` string, required
  - `title` string, required
  - `objectIdentity` union, required: Object to identify what was requested for download
    - DownloadAssetItemIdentity
      - `type` 'asset', required
      - `id` string, required
      - `formatId` string
      - `outputPath` string
    - DownloadAssetFileSetItemIdentitySchema
      - `type` 'fileSet', required
      - `id` string, required
      - `assetId` string, required
    - DownloadAssetVersionItemIdentity
      - `type` 'assetVersion', required
      - `versionId` string, required
      - `assetId` string, required
      - `formatId` string
    - DownloadAssetFileItemIdentity
      - `type` 'assetFile', required
      - `assetId` string, required
      - `id` string, required
      - `outputPath` string
    - DownloadCollectionItemIdentity
      - `type` 'collection', required
      - `id` string, required
      - `format` string, required
    - DownloadPlaylistItemIdentity
      - `type` 'playlist', required
      - `id` string, required
      - `format` string, required

---

[API](https://skmtc.dev/iconik/apis/agent-api.md) - [All operations](https://skmtc.dev/iconik/apis/agent-api/llms.txt) - [OpenAPI document](https://skmtc.dev/iconik/apis/agent-api/revisions/cd5eb7819e60?raw)