Shoot a product: N takes of one brief
- 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.
Takes of the same brief, one after another (the image model rate-limits, and four good takes beat three rejected at once), each metered and saved on its own: a failure half way leaves the takes that came out in the Library and charges only for those (creditsSpent, failed). Running out of credits after the first take stops the rest; before the first it is 403 insufficient_credits. A strict fidelity cuts the product out once first (studio.removeBg), charged with the first take that comes out; a shoot that gives nothing costs nothing. If none came out: 422 validation_error. It answers when all takes are done, which can be a few minutes at variants: 4; clients use a long timeout.
The Idempotency-Key keeps a retry from shooting, and paying for, the brief again. Make the follow-ups with refineShot and put a take on a listing with addLibraryAssetToProduct. Costs are in getStudioCosts.
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.
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
sourceUrls*array<>Photos of the product to shoot from: the url of a Library file or a product photo the business already stores. Two or three views (front, back, label) improve fidelity markedly. Any other URL is 422 validation_error.
1 <= items <= 4recipe*Everything but shot, fidelity and aspect is optional.
variants?integerHow many takes of the brief.
1 <= value <= 41productId?stringThe listing this is for: its title, type and vendor are given to the model, and the shots are linked to it in the Library.
Created
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/studio/shoots' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "sourceUrls": [ "https://example.com" ], "recipe": { "shot": "packshot", "fidelity": "strict", "aspect": "1:1" }}'{ "data": { "shootId": "string", "assets": [ { "id": "string", "url": "string" } ], "failed": 0, "creditsSpent": 0 }}Start a Studio make in the background POST
Answers at once with a running job; follow it with `getStudioJob`. Credits are charged only when the make comes out (a video or promo is charged at the start and given back if it fails). `kind` picks the make: `adset`, `listing` and `translate` and `week` write words (the job's `result`); `logo`, `edit`, `voice` and `music` add a file to the Library. A photo is a Library id, or the URL of one of the business's own stored photos. `video` (8 seconds from one photo) and `promo` (a storyboard written from the shop's listings and reviews, with voice and music) take a few minutes: follow them with `getStudioJob`. Owner or admin. Storage: refused with 403 `plan_limit` when it would take the Library over the plan's storage. What is already stored stays. Access: OAuth scope `ai:spend`; write-gated by the subscription.
Upcoming appointments and tour departures, soonest first GET
Access: OAuth scope `orders:read`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 50, at most 250) and an opaque `cursor`. It pages through the newest 250.