Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
contact: {}
description: 'API request bodies and responses are usually JSON-encoded, except for binary data and some of the OAuth2 endpoints. Note that the `Content-Type` header must be set to `application/json` for this, as the request may otherwise fail with error 400.
When clients have a valid access token, e.g. obtained through the `POST /api/v1/session` or `POST /api/v1/oauth/token` endpoint, they can use a standard Bearer Authorization header to authenticate their requests. Submitting the access token with a custom `X-Auth-Token` header is supported as well.'
title: PhotoPrism Download API
version: v1
servers:
- url: https://demo.photoprism.app
security:
- BearerAuth: []
tags:
- name: Download
paths:
/api/v1/albums/{uid}/dl:
get:
operationId: DownloadAlbum
parameters:
- description: Album UID
in: path
name: uid
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/zip:
schema:
type: string
format: binary
'403':
description: Forbidden
content:
application/zip:
schema:
$ref: '#/components/schemas/i18n.Response'
'404':
description: Not Found
content:
application/zip:
schema:
$ref: '#/components/schemas/i18n.Response'
'429':
description: Too Many Requests
content:
application/zip:
schema:
$ref: '#/components/schemas/i18n.Response'
'500':
description: Internal Server Error
content:
application/zip:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: streams the album contents as zip archive
tags:
- Download
/api/v1/zip:
post:
operationId: ZipCreate
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
format: binary
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'413':
description: Request Entity Too Large
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: creates a zip file archive for download
tags:
- Download
/api/v1/zip/{filename}:
get:
operationId: ZipDownload
parameters:
- description: zip archive filename returned by the POST /api/v1/zip endpoint
in: path
name: filename
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/zip:
schema:
type: string
format: binary
'403':
description: Forbidden
content:
application/zip:
schema:
$ref: '#/components/schemas/i18n.Response'
'404':
description: Not Found
content:
application/zip:
schema:
$ref: '#/components/schemas/i18n.Response'
'429':
description: Too Many Requests
content:
application/zip:
schema:
$ref: '#/components/schemas/i18n.Response'
'500':
description: Internal Server Error
content:
application/zip:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: returns a zip file archive after it has been created
tags:
- Download
components:
schemas:
i18n.Response:
properties:
code:
type: integer
details:
type: string
error:
type: string
message:
type: string
messageId:
type: string
messageParams:
items: {}
type: array
type: object
securitySchemes:
BearerAuth:
in: header
name: Authorization
type: apiKey
externalDocs:
description: Learn more ›
url: https://docs.photoprism.app/developer-guide/api/