PhotoPrism Faces API
The Faces API from PhotoPrism — 2 operation(s) for faces.
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-faces-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 Faces API
version: v1
servers:
- url: https://demo.photoprism.app
security:
- BearerAuth: []
tags:
- name: Faces
paths:
/api/v1/faces:
get:
operationId: SearchFaces
parameters:
- description: maximum number of results
in: query
name: count
required: true
schema:
type: integer
maximum: 100000
minimum: 1
- description: search result offset
in: query
name: offset
schema:
type: integer
maximum: 100000
minimum: 0
- description: sort order
in: query
name: order
schema:
type: string
enum:
- subject
- added
- samples
- description: show hidden
in: query
name: hidden
schema:
type: string
enum:
- 'yes'
- 'no'
- description: show unknown
in: query
name: unknown
schema:
type: string
enum:
- 'yes'
- 'no'
responses:
'200':
description: OK
headers:
X-Count:
description: The actual number of faces returned
schema:
type: number
X-Limit:
description: The limit of the number of faces to be returned
schema:
type: number
X-Offset:
description: The offset that was used
schema:
type: number
content:
application/json:
schema:
items:
$ref: '#/components/schemas/search.Face'
type: array
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'401':
description: Unauthorized
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'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: finds and returns faces as JSON
tags:
- Faces
/api/v1/faces/{id}:
get:
operationId: GetFace
parameters:
- description: face id
in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/entity.Face'
'401':
description: Unauthorized
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'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: returns a face as JSON
tags:
- Faces
put:
operationId: UpdateFace
parameters:
- description: face id
in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/entity.Face'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'401':
description: Unauthorized
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'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'413':
description: Request Entity Too Large
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: updates face properties
tags:
- Faces
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/form.Face'
description: properties to be updated
required: true
components:
schemas:
form.Face:
properties:
Hidden:
type: boolean
SubjUID:
type: string
type: object
search.Face:
properties:
CollisionRadius:
type: number
Collisions:
type: integer
CreatedAt:
type: string
FaceDist:
type: number
FileUID:
type: string
Hidden:
type: boolean
ID:
type: string
Invalid:
type: boolean
MarkerUID:
type: string
MatchedAt:
type: string
Name:
type: string
Review:
type: boolean
SampleRadius:
type: number
Samples:
type: integer
Score:
type: integer
Size:
type: integer
Src:
type: string
SubjSrc:
type: string
SubjUID:
type: string
Thumb:
type: string
UpdatedAt:
type: string
type: object
entity.Face:
properties:
CollisionRadius:
type: number
Collisions:
type: integer
CreatedAt:
type: string
Hidden:
type: boolean
ID:
type: string
Kind:
type: integer
MatchedAt:
type: string
SampleRadius:
type: number
Samples:
type: integer
Src:
type: string
SubjUID:
type: string
UpdatedAt:
type: string
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
securitySchemes:
BearerAuth:
in: header
name: Authorization
type: apiKey
externalDocs:
description: Learn more ›
url: https://docs.photoprism.app/developer-guide/api/