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
The artwork id.
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": "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}Take an artwork live POST
Makes the artwork's newest saved version the live, publicly readable state. Pending unsaved edits are left alone. Fails if the artwork has never been saved.
Delete an artwork image DELETE
Deletes an image row and removes its backing object from Storage. Requires a first-party session.