Register an artwork image
Registers an already-uploaded object (from the upload-url endpoint) as an image row, appended to the end. Requires a first-party session.
Registers an already-uploaded object (from the upload-url endpoint) as an image row, appended to the end. Requires a first-party session.
Authorization
bearerAuth artworks:createA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: artworks:create
Path Parameters
Header Parameters
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.
Register an uploaded image object as an artwork image.
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", "storage_path": "string", "url": "string", "alt_text": "string", "kind": "artwork", "width": -9007199254740991, "height": -9007199254740991, "position": -9007199254740991, "created_at": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}Get an artwork GET
Returns the published artwork. Pass `draft=true` to get the editor's working copy (pending edits overlaid).
Add an artwork image by URL POST
Fetches a public image URL server-side, stores it, and registers it as an image on the artwork — the programmatic path for the API, the assistant, and agents, which can't PUT bytes to a signed URL. The URL is validated (https, size, type, host) before fetch. Reachable with an API key.