Gallery Platform API
Reference

Find visually similar artworks

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.

GET
/gallery/artworks/{id}/similar

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.

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

Path Parameters

id*string

Query Parameters

limit?integer
Range1 <= value <= 50
Default12

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "data": [    {      "artwork": {        "id": "string",        "title": "string",        "artist_id": "string",        "artist_name": "string",        "thumbnail_url": "string",        "inventory_number": "string",        "ownership_status": "owned",        "availability_state": "available",        "status": "available",        "medium": "string",        "year": -9007199254740991,        "description": "string",        "dimension_unit": "in",        "height_cm": 0,        "width_cm": 0,        "depth_cm": 0,        "framed_height_cm": 0,        "framed_width_cm": 0,        "framed_depth_cm": 0,        "dimensions_text": "string",        "location": "string",        "location_id": "string",        "price_cents": -9007199254740991,        "currency": "string",        "is_edition": true,        "edition_number": -9007199254740991,        "edition_size": -9007199254740991,        "edition_type": "numbered",        "edition_overrides": [          "string"        ],        "parent_artwork_id": "string",        "coa_status": "not_required",        "coa_tracking_number": "string",        "condition_status": "excellent",        "condition_notes": "string",        "provenance": "string",        "exhibition_history": "string",        "literature": "string",        "catalogue_raisonne": "string",        "market": "primary",        "custom_status_id": "string",        "show_price_publicly": true,        "published_at": "string",        "published_version": -9007199254740991,        "source_system": "string",        "source_external_id": "string",        "formats": [          {            "id": "string",            "artwork_id": "string",            "label": "string",            "height_cm": 0,            "width_cm": 0,            "depth_cm": 0,            "dimension_unit": "in",            "medium": "string",            "edition_size": -9007199254740991,            "stock_quantity": -9007199254740991,            "availability_state": "available",            "price_cents": -9007199254740991,            "currency": "string",            "position": -9007199254740991,            "metadata": {              "property1": "string",              "property2": "string"            },            "created_at": "string",            "updated_at": "string"          }        ],        "metadata": {          "property1": "string",          "property2": "string"        },        "created_at": "string",        "updated_at": "string"      },      "similarity": 0    }  ]}

Preview a work to scale in a room POST

Renders the work hanging to true scale in the chosen room scene and returns a short-lived signed image URL. Deterministic and cached by storage path.

Summarize inventory GET

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.