What is the base URL of the Shotova API?

The base URL is https://shotova.com/api/v1. Every endpoint sits under it, takes JSON and answers with JSON, and GET https://shotova.com/api/v1 lists every endpoint without a key.

How do I authenticate with the Shotova API?

Send your API key in the Authorization header as a Bearer token: Authorization: Bearer shtv_sk_ followed by the rest of the key. The X-API-Key header with the bare key also works. Keys are made in Shotova under Settings, API keys.

What are the Shotova API rate limits?

Each key can send 120 requests a minute, of which 10 can be requests that make something, and each account can run 3 such requests at once. Each key also has a daily credit limit from 1 to 2,000 credits, 200 by default, counted per UTC day.

How do I know when a Shotova API job is finished?

A call that is not done within about 40 seconds answers with status 202 and a job id. Poll GET /api/v1/jobs/{id} every 5 to 10 seconds; it shows status processing until the result is ready, then returns the result. Jobs are kept for 12 hours.

Does the Shotova API charge for failed requests?

No. A request that fails is not charged, credits for work that fails later are refunded, and in a batch only the images that were made are charged.

How do I retry a Shotova API request without paying twice?

Send an Idempotency-Key header with a unique value for that action. The same key with the same request returns the first answer, with the header Idempotent-Replayed: true, instead of doing the work again.

Which image formats does the Shotova API accept?

JPEG, PNG and WebP photos up to 20 MB, sent as a public https link or uploaded as base64 to POST /api/v1/uploads. Links to private network addresses are refused.

Can I use the Shotova API with Shopify or my own store?

Yes. Any software that can send an https request can call the Shotova API, including a script, a store plugin you build, or a scheduled job on your server. Keep the key on the server, never in a web page.

Shotova API Reference: Endpoints, Errors and Limits