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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/photoprism:photoprism-sharing-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.

GitHub Google LinkedIn

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 Sharing API
  version: v1
servers:
- url: https://demo.photoprism.app
security:
- BearerAuth: []
tags:
- name: Sharing
paths:
  /s/{token}:
    get:
      operationId: ShareToken
      parameters:
      - description: Share token
        in: path
        name: token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Rendered HTML page
          content:
            text/html:
              schema:
                type: string
        '302':
          description: Redirect to the base site when the token is invalid
          content:
            text/html:
              schema:
                type: string
      summary: creates a session using the specified share token and renders the generic…
      tags:
      - Sharing
  /s/{token}/{shared}:
    get:
      operationId: ShareTokenShared
      parameters:
      - description: Share token
        in: path
        name: token
        required: true
        schema:
          type: string
      - description: Shared resource UID
        in: path
        name: shared
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Rendered HTML page
          content:
            text/html:
              schema:
                type: string
        '302':
          description: Redirect to the base site when the token is invalid
          content:
            text/html:
              schema:
                type: string
      summary: creates a session with the specified share token and redirects to the shared…
      tags:
      - Sharing
  /s/{token}/{shared}/preview:
    get:
      operationId: SharePreview
      parameters:
      - description: Share token
        in: path
        name: token
        required: true
        schema:
          type: string
      - description: Shared resource UID
        in: path
        name: shared
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Preview image
          content:
            image/jpeg:
              schema:
                type: string
                format: binary
        '302':
          description: Redirect to the default preview page
          content:
            image/jpeg:
              schema:
                type: string
      summary: returns a share preview image when the token is valid
      tags:
      - Sharing
components:
  securitySchemes:
    BearerAuth:
      in: header
      name: Authorization
      type: apiKey
externalDocs:
  description: Learn more ›
  url: https://docs.photoprism.app/developer-guide/api/