PhotoPrism Images API
The Images API from PhotoPrism — 6 operation(s) for images.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/photoprism:photoprism-images-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
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 Images API
version: v1
servers:
- url: https://demo.photoprism.app
security:
- BearerAuth: []
tags:
- name: Images
paths:
/api/v1/albums/{uid}/t/{token}/{size}:
get:
description: Returns a generic placeholder icon when a cover file is assigned to the album; request the picture from /api/v1/t/{hash}/{token}/{size} instead, using its hash. Covers are always served inline; use the download endpoints to obtain a file.
operationId: AlbumCover
parameters:
- description: Album UID
in: path
name: uid
required: true
schema:
type: string
- description: user-specific security token provided with session or 'public' when running PhotoPrism in public mode
in: path
name: token
required: true
schema:
type: string
- description: cover image size; larger sizes are reduced
in: path
name: size
required: true
schema:
type: string
enum:
- tile_50
- tile_100
- left_224
- right_224
- tile_224
- tile_500
- fit_720
responses:
'200':
description: OK
content:
image/jpeg:
schema:
type: string
format: binary
image/svg+xml:
schema:
type: string
format: binary
'403':
description: Forbidden
content:
image/jpeg:
schema:
type: string
format: binary
image/svg+xml:
schema:
type: string
format: binary
summary: returns an album cover image
tags:
- Images
/api/v1/dl/{file}:
get:
operationId: GetDownload
parameters:
- description: file hash or unique download id
in: path
name: file
required: true
schema:
type: string
- description: download token
in: query
name: t
schema:
type: string
- description: attachment name type (file, share, original)
in: query
name: name
schema:
type: string
- description: avc returns an MPEG-4 AVC rendition of a video, live photo, or animated image
in: query
name: format
schema:
type: string
responses:
'200':
description: OK
content:
application/octet-stream:
schema:
type: string
format: binary
video/mp4:
schema:
type: string
format: binary
'403':
description: Forbidden
content:
application/octet-stream:
schema:
type: string
format: binary
video/mp4:
schema:
type: string
format: binary
'404':
description: Not Found
content:
application/octet-stream:
schema:
type: string
format: binary
video/mp4:
schema:
type: string
format: binary
'429':
description: Too Many Requests
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/i18n.Response'
video/mp4:
schema:
$ref: '#/components/schemas/i18n.Response'
'507':
description: Insufficient Storage
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/i18n.Response'
video/mp4:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: returns the raw file data
tags:
- Images
/api/v1/folders/t/{uid}/{token}/{size}:
get:
description: Covers are always served inline; use the download endpoints to obtain a file.
operationId: FolderCover
parameters:
- description: folder uid
in: path
name: uid
required: true
schema:
type: string
- description: user-specific security token provided with session or 'public' when running PhotoPrism in public mode
in: path
name: token
required: true
schema:
type: string
- description: cover image size; larger sizes are reduced
in: path
name: size
required: true
schema:
type: string
enum:
- tile_50
- tile_100
- left_224
- right_224
- tile_224
- tile_500
- fit_720
responses:
'200':
description: OK
content:
image/jpeg:
schema:
type: string
format: binary
image/svg+xml:
schema:
type: string
format: binary
'403':
description: Forbidden
content:
image/jpeg:
schema:
type: string
format: binary
image/svg+xml:
schema:
type: string
format: binary
summary: returns a folder cover image
tags:
- Images
/api/v1/labels/{uid}/t/{token}/{size}:
get:
description: Returns a generic placeholder icon when a cover file is assigned to the label; request the picture from /api/v1/t/{hash}/{token}/{size} instead, using its hash. Covers are always served inline; use the download endpoints to obtain a file.
operationId: LabelCover
parameters:
- description: Label UID
in: path
name: uid
required: true
schema:
type: string
- description: user-specific security token provided with session or 'public' when running PhotoPrism in public mode
in: path
name: token
required: true
schema:
type: string
- description: cover image size; larger sizes are reduced
in: path
name: size
required: true
schema:
type: string
enum:
- tile_50
- tile_100
- left_224
- right_224
- tile_224
- tile_500
- fit_720
responses:
'200':
description: OK
content:
image/jpeg:
schema:
type: string
format: binary
image/svg+xml:
schema:
type: string
format: binary
'403':
description: Forbidden
content:
image/jpeg:
schema:
type: string
format: binary
image/svg+xml:
schema:
type: string
format: binary
summary: returns a label cover image
tags:
- Images
/api/v1/photos/{uid}/dl:
get:
operationId: GetPhotoDownload
parameters:
- description: photo uid
in: path
name: uid
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/octet-stream:
schema:
type: string
format: binary
'403':
description: Forbidden
content:
application/octet-stream:
schema:
type: string
format: binary
'404':
description: Not Found
content:
application/octet-stream:
schema:
type: string
format: binary
'429':
description: Too Many Requests
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: returns the primary file matching that belongs to the photo
tags:
- Images
/api/v1/t/{thumb}/{token}/{size}:
get:
description: 'For more information see:
- https://docs.photoprism.app/developer-guide/api/thumbnails/#image-endpoint-uri'
operationId: GetThumb
parameters:
- description: SHA1 file hash, optionally with a crop area suffixed, e.g. '-016014058037'
in: path
name: thumb
required: true
schema:
type: string
- description: user-specific security token provided with session or 'public' when running PhotoPrism in public mode
in: path
name: token
required: true
schema:
type: string
- description: thumbnail size; sizes above the server limit are reduced
in: path
name: size
required: true
schema:
type: string
enum:
- tile_50
- tile_100
- left_224
- right_224
- tile_224
- tile_500
- fit_720
- tile_1080
- fit_1280
- fit_1600
- fit_1920
- fit_2048
- fit_2560
- fit_3840
- fit_4096
- fit_5120
- fit_7680
- fit_15360
- description: returns the thumbnail as an attachment named <stem>_<size> with the extension of the thumbnail, or after the crop size for a cropped thumbnail; placeholders then use 400, 404, or 500
in: query
name: download
schema:
type: string
- description: attachment name type (file, share, original)
in: query
name: name
schema:
type: string
responses:
'200':
description: OK
content:
image/jpeg:
schema:
type: string
format: binary
' image/svg+xml':
schema:
type: string
format: binary
'400':
description: Bad Request
content:
image/jpeg:
schema:
type: string
format: binary
' image/svg+xml':
schema:
type: string
format: binary
'403':
description: Forbidden
content:
image/jpeg:
schema:
type: string
format: binary
' image/svg+xml':
schema:
type: string
format: binary
'404':
description: Not Found
content:
image/jpeg:
schema:
type: string
format: binary
' image/svg+xml':
schema:
type: string
format: binary
'500':
description: Internal Server Error
content:
image/jpeg:
schema:
type: string
format: binary
' image/svg+xml':
schema:
type: string
format: binary
summary: returns a thumbnail image with the requested size
tags:
- Images
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/