Download API

Base URL: https://YOUR-SERVER/api. Send your API key in x-api-key where authentication is required. A key also needs the listed permission; your account's access rules still apply.

API guide · All endpoints · OpenAPI JSON

• POST /download/archive — Download asset archive
• POST /download/info — Retrieve download information

Download asset archive

POST /api/download/archive

Download a ZIP archive containing the specified assets. The assets must have been previously requested via the "getDownloadInfo" endpoint.

Authentication: API key. Permission: asset.download.

Parameters

Name	Where	Required	Description
key	query	No	string
slug	query	No	string

Parameter types, defaults and constraints

[
  {
    "name": "key",
    "required": false,
    "in": "query",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "slug",
    "required": false,
    "in": "query",
    "schema": {
      "type": "string"
    }
  }
]

Request body

Required.

Field definitions: DownloadArchiveDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/DownloadArchiveDto"
    }
  }
}

Responses

{
  "200": {
    "content": {
      "application/octet-stream": {
        "schema": {
          "format": "binary",
          "type": "string"
        }
      }
    },
    "description": ""
  }
}

Retrieve download information

POST /api/download/info

Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together.

Authentication: API key. Permission: asset.download.

Parameters

Name	Where	Required	Description
key	query	No	string
slug	query	No	string

Parameter types, defaults and constraints

[
  {
    "name": "key",
    "required": false,
    "in": "query",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "slug",
    "required": false,
    "in": "query",
    "schema": {
      "type": "string"
    }
  }
]

Request body

Required.

Field definitions: DownloadInfoDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/DownloadInfoDto"
    }
  }
}

Responses

Field definitions: DownloadResponseDto

{
  "201": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/DownloadResponseDto"
        }
      }
    },
    "description": ""
  }
}