Skip to content

Overview

The Shootika API lets your own software add products, pick a model and a style, shoot on-model photos of a garment, and approve the ones you like so they appear on the product.

The usual flow is: create a product with a photo (POST /products), choose a scene with GET /models, GET /styles and POST /scenes, start a shoot with POST /frames, poll GET /frames/{frame_id} until its status is ready, then approve it with POST /frames/{frame_id}/approval.

Every request needs your API key in the header Authorization: Bearer shootika_sk_.... Create keys in the web app under Settings, API Keys. Each key may make 120 requests a minute. Above that the API answers 429 rate_limited with a Retry-After header.

Every id is a UUID string. Lists are paged with page and page_size (default 24, at most 100) and answer page, page_size and total next to the items. Every error has the same shape: {"error": {"code", "message", "details"}}, where details is only present for some codes. Read the code, not the message, in your software.

Every POST accepts an Idempotency-Key header. Retrying a request with the same key and the same body replays the first answer instead of doing the work twice.

Information

  • OpenAPI version: 3.1.0

Your API key, which starts with shootika_sk_.... Create one in the web app under Settings, API Keys. Send it as Authorization: Bearer shootika_sk_.... When a store uninstalls Shootika its keys stop working, and every request with one answers 403 store_uninstalled.

Security scheme type: http