Gallery Platform API
Read and manage a gallery's content over a versioned, gallery-scoped REST API.
Welcome to the developer documentation for the Gallery Platform API.
The API is gallery-scoped: you authenticate with a gallery API key (gpk_…),
and the gallery is implicit in the key. Every endpoint lives under /api/v1.
Getting started
Mint a key and make your first request in minutes.
Authentication
Principals, scopes, and how the gallery is chosen per request.
API reference
Every endpoint, generated from the OpenAPI document, with a built-in playground.
Webhooks
Receive signed events when the gallery's content changes.
What you can build
- Inventory — create, update, publish, and search artworks, with images, formats, locations, tags, and publications.
- CRM — manage contacts, interactions, tasks, contact lists, deals, and pipelines.
- Sales & money — record sales, issue invoices, take payments, and settle consignor payables.
- Offers & lists — assemble presentations, send offers to collectors, and track engagement.
- Inbox & reporting — read and reply to gallery message threads, and pull saved reports.
Conventions at a glance
The whole API shares one set of mechanics, each covered by a short guide:
errors follow RFC 9457 application/problem+json, list
endpoints use cursor pagination, every response carries
IETF RateLimit headers so clients can self-throttle,
and writes accept an Idempotency-Key so retries are
safe.
The OpenAPI document
The reference is generated from our machine-readable spec, which is public and
CORS-open at GET /api/v1/openapi.json — point your own code generators
and tooling at it.