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 Videos API
version: v1
servers:
- url: https://demo.photoprism.app
security:
- BearerAuth: []
tags:
- name: Videos
paths:
/api/v1/videos/{hash}/{token}/{format}:
get:
description: 'For more information see:
- https://docs.photoprism.app/developer-guide/api/thumbnails/#video-endpoint-uri'
operationId: GetVideo
parameters:
- description: SHA1 video file hash
in: path
name: hash
required: true
schema:
type: string
- description: user-specific security token provided with session
in: path
name: token
required: true
schema:
type: string
- description: video format, e.g. mp4
in: path
name: format
required: true
schema:
type: string
responses:
'403':
description: Forbidden
content:
video/mp4:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: returns a video, optionally limited to a byte range for streaming
tags:
- Videos
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/