API Reference

PicPeak provides an Admin API for automation and integration. The machine-readable OpenAPI spec is at docs/picpeak-admin-api.openapi.yaml in the repository.

Base URL

http://localhost:3001/api

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

Key endpoints

• Authentication --- obtain and use admin API tokens.
• Events --- create, list, update, and publish events.
• Photos --- upload photos and manage event media.

OpenAPI documentation

Preview the spec interactively:

npx --yes @redocly/cli preview-docs docs/picpeak-admin-api.openapi.yaml

Import it into Postman, Insomnia, or any OpenAPI-compatible tool.

Validate after changes:

npx --yes @apidevtools/[email protected] validate docs/picpeak-admin-api.openapi.yaml