PhotoPrism Folders API
The Folders API from PhotoPrism — 3 operation(s) for folders.
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-folders-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 Folders API
version: v1
servers:
- url: https://demo.photoprism.app
security:
- BearerAuth: []
tags:
- name: Folders
paths:
/api/v1/folders/import:
get:
operationId: SearchFoldersImport
responses:
'200':
description: OK
headers:
X-Count:
description: The actual number of files and folders returned. Do not use for determining if all the results have been returned.
schema:
type: number
X-Files:
description: The actual number of files returned. Use this for comparing to X-Limit to determine if all the results have been returned.
schema:
type: number
X-Folders:
description: The actual number of folders returned. Do not use for determining if all the results have been returned.
schema:
type: number
X-Limit:
description: The limit of the number of files to be returned
schema:
type: number
X-Offset:
description: The offset that was used
schema:
type: number
content:
application/json:
schema:
$ref: '#/components/schemas/api.FoldersResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: list folders in import
tags:
- Folders
/api/v1/folders/originals:
get:
operationId: SearchFoldersOriginals
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.FoldersResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: list folders in originals
tags:
- Folders
/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:
- Folders
components:
schemas:
time.Duration:
format: int64
type: integer
api.FoldersResponse:
properties:
cached:
type: boolean
files:
items:
$ref: '#/components/schemas/entity.File'
type: array
folders:
items:
$ref: '#/components/schemas/entity.Folder'
type: array
recursive:
type: boolean
root:
type: string
type: object
entity.File:
properties:
AspectRatio:
type: number
Chroma:
type: integer
Codec:
type: string
ColorProfile:
type: string
Colors:
type: string
CreatedAt:
type: string
CreatedIn:
type: integer
DeletedAt:
type: string
Diff:
type: integer
Duration:
$ref: '#/components/schemas/time.Duration'
Error:
type: string
FPS:
type: number
FileType:
type: string
Frames:
type: integer
HDR:
type: boolean
Hash:
type: string
Height:
type: integer
InstanceID:
type: string
Luminance:
type: string
MainColor:
type: string
MediaID:
type: string
MediaType:
type: string
MediaUTC:
type: integer
Mime:
type: string
Missing:
type: boolean
ModTime:
type: integer
Name:
type: string
Orientation:
type: integer
OrientationSrc:
type: string
OriginalName:
type: string
Pages:
type: integer
PhotoUID:
type: string
Portrait:
type: boolean
Primary:
type: boolean
Projection:
type: string
PublishedAt:
type: string
Root:
type: string
Sidecar:
type: boolean
Size:
type: integer
Software:
type: string
TakenAt:
type: string
TimeIndex:
type: string
UID:
type: string
UpdatedAt:
type: string
UpdatedIn:
type: integer
Video:
type: boolean
Watermark:
type: boolean
Width:
type: integer
type: object
i18n.Response:
properties:
code:
type: integer
details:
type: string
error:
type: string
message:
type: string
messageId:
type: string
messageParams:
items: {}
type: array
type: object
entity.Folder:
properties:
Category:
type: string
Country:
type: string
Day:
type: integer
Description:
type: string
Favorite:
type: boolean
FileCount:
type: integer
Ignore:
type: boolean
ModifiedAt:
type: string
Month:
type: integer
Order:
type: string
Path:
type: string
Private:
type: boolean
PublishedAt:
type: string
Root:
type: string
Title:
type: string
Type:
type: string
UID:
type: string
Watch:
type: boolean
Year:
type: integer
type: object
securitySchemes:
BearerAuth:
in: header
name: Authorization
type: apiKey
externalDocs:
description: Learn more ›
url: https://docs.photoprism.app/developer-guide/api/