Docs

Documentation

The full guides are on their way. Until then the API reference covers every endpoint, and the quickstart below gets you to a first image in a few minutes.

Start here

Reference
API reference

Every operation, field, scope and example, generated from the live contract.
Open the reference
Contract
OpenAPI 3.1

The machine-readable contract for code generators, Postman and AI agents.
openapi.json
Errors
Error codes

Every error code with its HTTP status and what to do about it.
Error catalogue
For agents
llms.txt

A plain-text map of StoreShot for language models, with links to Markdown pages.
Read llms.txt

Quickstart outline

Create a test key in the developer console.
Upload a screenshot: POST /uploads.
Generate one image (POST /generations) or a whole listing (POST /screenshot-sets).
Wait with Prefer: wait=60, poll, or subscribe to a webhook.
Switch to a live key and buy credits when the integration works.

Code samples in curl, Node.js and Python are on the API overview.

Guides coming soon

Generating a whole store listing with screenshot sets and fastlane
Webhooks: verifying signatures and handling retries
Uploads: presigned uploads and URL imports
Credits, plans and limits in production