Gallery Platform API
Reference

Add artworks to a show

Adds artworks to the show's checklist, after its last position, in the order given. A work already on the show is left as it is and listed in `already_on_show`, so a repeated call changes nothing. The other fields apply to every work added. Needs `artworks:read` to check the works.

POST
/gallery/shows/{showId}/artworks

Adds artworks to the show's checklist, after its last position, in the order given. A work already on the show is left as it is and listed in already_on_show, so a repeated call changes nothing. The other fields apply to every work added. Needs artworks:read to check the works.

Authorization

bearerAuth shows:update, artworks:read
AuthorizationBearer <token>

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

In: header

Scope: shows:update, artworks:read

Path Parameters

showId*string

The show id.

Query Parameters

dry_run?boolean

Preview this operation without committing it. When true, the request is authenticated, scoped, and validated, but no side effect runs — no write, no idempotency claim, no audit event, no outbound delivery. The response is HTTP 200 with an X-Dry-Run: true header and a body of { "dry_run": true }, plus an effect object describing what the real call would change when this operation can resolve one.

Header Parameters

Idempotency-Key?string

Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "data": [    {      "show_id": "string",      "artwork_id": "string",      "artwork_title": "string",      "position": -9007199254740991,      "catalogue_number": "string",      "checklist_status": "proposed",      "lender_party_id": "string",      "note": "string",      "booth_id": "string",      "wall": "string",      "priority": -9007199254740991,      "valid_from": "string"    }  ],  "already_on_show": [    "string"  ]}