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 WebSocket API
version: v1
servers:
- url: https://demo.photoprism.app
security:
- BearerAuth: []
tags:
- name: Websocket
paths:
/ws:
get:
operationId: WebSocket
responses:
'101':
description: Switching Protocols
content:
application/json:
schema:
type: string
'403':
description: Forbidden
content:
application/json:
schema:
type: string
summary: opens a WebSocket connection for real-time events
tags:
- Websocket
components:
securitySchemes:
BearerAuth:
in: header
name: Authorization
type: apiKey
externalDocs:
description: Learn more ›
url: https://docs.photoprism.app/developer-guide/api/