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.
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 Debug API
version: v1
servers:
- url: https://demo.photoprism.app
security:
- BearerAuth: []
tags:
- name: Debug
paths:
/api/v1/echo:
get:
operationId: Echo
responses:
'200':
description: OK
summary: returns the request and response headers as JSON if debug mode is enabled
tags:
- Debug
/api/v1/status:
get:
operationId: GetStatus
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
summary: responds with status code 200 if the server is operational
tags:
- Debug
/swagger.json:
get:
operationId: GetDocs
responses:
'200':
description: Swagger JSON
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
summary: serves embedded Swagger documentation (debug builds only)
tags:
- Debug
components:
schemas:
gin.H:
additionalProperties: {}
type: object
securitySchemes:
BearerAuth:
in: header
name: Authorization
type: apiKey
externalDocs:
description: Learn more ›
url: https://docs.photoprism.app/developer-guide/api/