Gallery Platform API
Reference

Summarize inventory

Server-computed aggregates over the gallery's artworks for a filter set: the matching total, counts by work status, value totals summed per currency, and the unpriced count. Accepts the same filters as the list endpoint (status, artist_id, price/year bands, unpriced, published). Use this — not paging the list — to answer 'how many' / 'how much' questions correctly at any scale.

GET
/gallery/artworks/summary

Server-computed aggregates over the gallery's artworks for a filter set: the matching total, counts by work status, value totals summed per currency, and the unpriced count. Accepts the same filters as the list endpoint (status, artist_id, price/year bands, unpriced, published). Use this — not paging the list — to answer 'how many' / 'how much' questions correctly at any scale.

Authorization

bearerAuth artworks:read
AuthorizationBearer <token>

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

In: header

Scope: artworks:read

Query Parameters

ids?array<string>
Items1 <= items <= 50
q?string
Lengthlength <= 200
status?array<>
Items1 <= items
availability?array<>
Items1 <= items
ownership?array<>
Items1 <= items
condition?array<>
Items1 <= items
market?array<>
Items1 <= items
artist_id?string
medium?string
Lengthlength <= 200
price_min?integer
Range0 <= value <= 9007199254740991
price_max?integer
Range0 <= value <= 9007199254740991
year_min?integer
Range-9007199254740991 <= value <= 9007199254740991
year_max?integer
Range-9007199254740991 <= value <= 9007199254740991
height_min?number
Range0 <= value
height_max?number
Range0 <= value
width_min?number
Range0 <= value
width_max?number
Range0 <= value
unpriced?string
published?string|string
has_image?string
tag_id?array<string>
Items1 <= items <= 10

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "total": -9007199254740991,  "by_status": {    "property1": -9007199254740991,    "property2": -9007199254740991  },  "by_availability": {    "property1": -9007199254740991,    "property2": -9007199254740991  },  "by_ownership": {    "property1": -9007199254740991,    "property2": -9007199254740991  },  "by_market": {    "property1": -9007199254740991,    "property2": -9007199254740991  },  "value": [    {      "currency": "string",      "count_priced": -9007199254740991,      "sum_cents": -9007199254740991    }  ],  "unpriced": -9007199254740991,  "base_currency": "string",  "converted_total_cents": -9007199254740991}

Find visually similar artworks GET

Returns artworks whose cover image is visually most similar to this one, most similar first, excluding the artwork itself. Empty until the work has been indexed by the visual-embedding worker.

Add a tag to a artwork POST

Adds a single tag to this artwork (idempotent — never clobbers its other tags). Returns the resulting tag set.