Gallery Platform API
Reference

Create an artwork format

Adds a sellable format/variant to an artwork, appended to the end. A supplied price writes the gated pricing sibling. Rejected on an edition umbrella (only its copies or a standalone work are sellable).

POST
/gallery/artworks/{id}/formats

Adds a sellable format/variant to an artwork, appended to the end. A supplied price writes the gated pricing sibling. Rejected on an edition umbrella (only its copies or a standalone work are sellable).

Authorization

bearerAuth artworks:create
AuthorizationBearer <token>

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

In: header

Scope: artworks:create

Path Parameters

id*string

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.

Create a format/variant on an artwork.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "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"}