Gallery Platform API
Reference

Create a location

Creates a managed location in the gallery (a place artworks can be assigned to).

POST
/gallery/locations

Creates a managed location in the gallery (a place artworks can be assigned to).

Authorization

bearerAuth locations:create
AuthorizationBearer <token>

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

In: header

Scope: locations:create

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 location.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "id": "string",  "name": "string",  "kind": "gallery",  "parent_id": "string",  "contact_id": "string",  "address": "string",  "notes": "string",  "is_active": true,  "metadata": {    "property1": "string",    "property2": "string"  },  "created_at": "string",  "updated_at": "string"}

Update an artwork list PATCH

Updates a list's title, kind, visibility, description, cover image, room toggles, per-room theme, audience, or access gate (email / room passcode).

Delete a location DELETE

Deletes a managed location. Its sub-locations are promoted to top-level and any artworks lose the pointer; movement history is retained.