Gallery Platform API
Reference

Search artworks by visual description

Returns artworks whose cover image best matches a natural-language description of a look (subject, palette, mood), most similar first. This is the visual arm — pair it with the metadata artwork search for artist/status/price. Empty until covers are indexed.

GET
/gallery/artworks/visual-search

Returns artworks whose cover image best matches a natural-language description of a look (subject, palette, mood), most similar first. This is the visual arm — pair it with the metadata artwork search for artist/status/price. Empty until covers are indexed.

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

q*string

A natural-language description of the look to match (subject, palette, mood).

Length1 <= length <= 1000
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    }  ]}