ShopEazydevelopers
API referenceMerchant API BetaStudio

An AI edit of one Library photo, as a new version

Beta
Credentials
  • OAuth access token
Scopes
ai:spend
Subscription
Needs an active plan. Otherwise 403 subscription_locked.
Daily limit
AI generations, 300 a day per store. Over the limit is 429 rate_limited.
Idempotency
Send an Idempotency-Key header. A retry with the same key does the work once.
POST
/v1/merchant/stores/{storeId}/library/{assetId}/edit

Every edit is a NEW file (versionOf is this one), so the original is never overwritten and the merchant can always go back. Charged only when the edit comes out (403 insufficient_credits, over_credit_limit, ai_not_configured; the cost per op is in getStudioCosts) and refused with 403 plan_limit when the result would take the Library over the plan's storage. Answers when done (a minute at most): the new LibraryAsset. The Idempotency-Key keeps a retry from paying for a second edit.

Swap a version onto the products showing the old one with updateProduct.

Access: OAuth scope ai:spend; write-gated by the subscription.

Authorization

merchantOAuth ai:spend
headerAuthorizationBearer <token>

OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.

Scope: ai:spend

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

assetId*string

A Library file id, from listLibrary.

Header Parameters

Idempotency-Key*string

Required on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.

Match^[A-Za-z0-9_-]{8,128}$

Request Body

application/json
  1. body
op*string

cutout puts the subject on pure white; enhance cleans the photo with bright, even light; expand zooms out and extends the scene; edit follows instruction; scene places the product in a preset scene (presetId, or custom with scene); look applies a Model look or a seasonal pack's look (lookId, or worn:custom with custom). The product itself is always kept faithful.

Value in"cutout""enhance""expand""edit""scene""look"
instruction?string

For edit: what to change. Required for edit; 422 when empty.

Lengthlength <= 300
presetId?string

For scene: a preset id, or custom with scene.

scene?string

For scene with presetId: custom.

Lengthlength <= 300
lookId?string

For look, for example worn:cape-town, or worn:custom with custom.

custom?string

For look with worn:custom.

Lengthlength <= 300

Response Body

Created

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/library/<assetId>/edit' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "op": "cutout"}'
Example Response
{  "data": {    "id": "string",    "kind": "string",    "media": "image",    "category": "string",    "url": "string",    "posterUrl": "string",    "about": "string",    "versionOf": "string",    "usedIn": [      {        "kind": "string",        "id": "string"      }    ],    "uses": 0,    "createdAt": 0  }}

A caption about this picture, in the shop's voice POST

Looks at the photo (or a video's cover) and the listing it was made for and writes one Instagram/Facebook caption in the store's brand voice. Free: it spends no credits, but is capped at 40 a day per business (429 `rate_limited`, shared response; nothing is counted when it fails). 422 `validation_error` for a file that is gone or a sound, 403 `ai_not_configured` where AI is off. It saves nothing: `sendLibraryAssetToPromote` makes the draft. Access: OAuth scope `marketing:write`; not write-gated.

Change one thing about a shot you already have POST

Product photography is six attempts, not one: this keeps what worked and changes only what was asked. The result is a CHILD of the shot (`versionOf`, the same shoot and recipe), never an overwrite, and costs one shot (`studio.mockup` in `getStudioCosts`), charged only when it comes out. 422 `validation_error` for an empty instruction or a shot that is gone. The `Idempotency-Key` keeps a retry from paying twice. Access: OAuth scope `ai:spend`; write-gated by the subscription.