A caption about this picture, in the shop's voice
- Credentials
- OAuth access token
- Scopes
marketing:write- Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
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.
merchantOAuth marketing:writeAuthorizationBearer <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: marketing:write
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}$OK
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/library/<assetId>/caption' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>'{ "data": { "caption": "string" }}How many files the Library holds, and what they cost to make GET
The two numbers at the top of the Library screen. Access: OAuth scope `store:read`; not write-gated.
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.