Skip to Content
API ReferenceOverview

API Reference

PicPeak has two APIs:

  • The public v1 API under /api/v1, authenticated with API tokens, for integrations and automation: create galleries, upload photos, list photos with their proofing marks, download originals, get share links.
  • The admin API under /api/admin, authenticated with an admin session JWT, which the admin UI itself uses.

Base URL

http://localhost:3001/api

Behind a reverse proxy: https://your-domain.com/api

Key endpoints

  • Authentication --- API tokens and admin session tokens.
  • Events --- create, list, update, and publish events.
  • Photos --- upload photos, download originals and manage event media.
  • Webhooks --- manage outbound webhooks and their deliveries.

OpenAPI documentation

The public v1 API is described by an OpenAPI 3 spec generated from the route definitions:

  • /api/openapi.json on your instance (admin login required).
  • A browseable Swagger UI at /api/docs on your instance (admin login required).

Import the spec into Postman, Insomnia, or any OpenAPI-compatible tool. The admin API has no published spec; the pages above document the routes integrations use.

Last updated on
Backup & RestoreAuthentication