Change one thing about a shot you already have
- 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-Keyheader. A retry with the same key does the work once.
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.
merchantOAuth ai:spendAuthorizationBearer <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
storeId*stringA store the person can reach. Any other id answers 404, never 403.
assetId*stringA Library file id, from listLibrary.
Idempotency-Key*stringRequired 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.
^[A-Za-z0-9_-]{8,128}$application/json- body
instruction*stringChange ONE thing about the shot (warmer light, a different surface). Everything else stays as it is.
1 <= length <= 300Created
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/library/<assetId>/refine' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "instruction": "string"}'{ "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 }}An AI edit of one Library photo, as a new version POST
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.
How a make is going GET
Running, done (with the result and files) or failed (nothing charged). Access: OAuth scope `store:read`; not write-gated.