Gallery Platform API
Reference

List the gallery's document presets

Returns the gallery's named presentation presets, the default first. Filtering by document_kind also returns the presets that apply to every kind, since those dress that document too.

GET
/gallery/document-presets

Returns the gallery's named presentation presets, the default first. Filtering by document_kind also returns the presets that apply to every kind, since those dress that document too.

Authorization

bearerAuth gallery:read
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: gallery:read

Query Parameters

document_kind?string

Return only the presets that could dress this document kind — the presets named for it AND the presets that apply to every kind.

Value in

  • "checklist"
  • "price_list"
  • "tearsheet"
  • "catalogue"
  • "wall_label"
  • "certificate_of_authenticity"
  • "fact_sheet"
  • "collector_preview"
  • "qr_label"
  • "press_release"
  • "invoice"
  • "consignor_statement"
  • "condition_report"
  • "consignment_report"
  • "insurance_schedule"
  • "legal_document"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "data": [    {      "id": "string",      "name": "string",      "document_kind": "checklist",      "is_default": true,      "accent_color": "string",      "font_family": "sans",      "font_id": "string",      "overrides": {        "property1": null,        "property2": null      },      "created_at": "string",      "updated_at": "string"    }  ]}

Get a document preset GET

Returns one named document presentation preset.

Replace a preset's authored prose PUT

Replaces the preset's prose for one document kind and locale. Whole-set: a slot you send is a value (an empty string renders a deliberate blank), and a slot you omit is deleted and inherits again. Requires the gallery:write scope (key) or editor membership (user).