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.
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:readA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: artworks:read
Path Parameters
The artwork id.
Query Parameters
Page size. Defaults to 20; the maximum is 100.
1 <= value <= 5012Response 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", "artists": [ { "artist_id": "string", "role": "primary", "position": -9007199254740991, "artist_name": "string" } ], "dimensions": [ { "component": "overall", "label": "string", "height_cm": 0, "width_cm": 0, "depth_cm": 0, "position": -9007199254740991, "note": "string" } ], "artist_name": "string", "thumbnail_url": "string", "inventory_number": "string", "ownership_status": "owned", "availability_state": "available", "medium": "string", "year": -9007199254740991, "end_year": -9007199254740991, "date_precision": "year", "date_display": "string", "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_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, "save_state": "new", "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 } ]}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}Save an artwork POST
Saves the artwork's pending edits: promotes them onto the record and snapshots a new version. Publication is unchanged — use `/go-live` to serve the saved version publicly.
Set an artwork's status POST
Sets the artwork's availability (and, optionally, its custom status label and ownership status) on the record now — live for every reader, whoever sends it. A pending draft that named the field is reconciled and the editor is told. Use this, not `PATCH`, for a state change.