Search docs

Search the TryOnCloud API docs

Guides

API changelog

Every change to the Developer API, newest first.

Changes to the Developer API, newest first. Existing request and response formats do not change without notice here; new fields and endpoints are added alongside them.

19 November 2026

  • New: Async try-ons: POST /api/v1/generations returns a job at once; read it at GET /api/v1/generations/:id. Docs
  • New: Batches of up to 500 try-ons from image URLs: POST /api/v1/batches, GET and DELETE /api/v1/batches/:id (cancelled items are refunded). Docs
  • New: Signed webhooks generation.completed, generation.failed and batch.completed, per request (webhook_url) or as an account endpoint with event selection and a test event on API Keys > Webhooks. Docs
  • New: GET /api/v1/results/:id downloads a stored result with your key. Async results are kept 7 days.
  • New: DELETE /api/v1/customers/:customer_id erases one end user's stored results and records. customer_id is accepted on /generate, /generations and batch items. Docs
  • New: Per-key monthly credit limit and expiry date, set when you create a key. Over the limit: 402 KEY_LIMIT_REACHED. Docs
  • New: Test mode (?mock=true) for async jobs and batches (up to 10 items), free.
  • Faster: The garment analysis is cached for 30 days, so repeat try-ons of the same product photo skip about 2 seconds.
  • Dashboard: Generations search by customer id or request id, period filter, Live view and CSV export. Overview shows median and p95 time and a credit runway.
  • Security: Webhooks are sent only to public addresses checked at connection time, never following redirects.

18 November 2026

  • New: Idempotency-Key header on POST /api/v1/generate; retries are never charged twice. Docs
  • New: X-Request-Id on every response (and request_id in error bodies), plus X-RateLimit-Limit and X-RateLimit-Remaining.
  • New: OpenAPI 3.1 spec at https://www.tryoncloud.com/api/v1/openapi.json.
  • New: Public service figures at GET /api/v1/status and the status page.
  • Docs: Output resolution stated: about 1 megapixel (the 1K class).

14 November 2026

  • New: Webhook header x-tryoncloud-signature-v2, which signs the timestamp together with the body so old deliveries can be rejected. x-tryoncloud-signature is unchanged. Docs
  • Changed: Rate limits are now enforced across all servers, with an account-wide limit of 600 generate requests per minute and a separate limit for test mode. Docs
  • New: GET /api/v1/credits to check remaining try-ons with your API key. Docs
  • New: MCP server at https://www.tryoncloud.com/api/mcp for Claude Code, Cursor and VS Code. Docs
  • New: JavaScript/TypeScript SDK. Docs
  • New: Free test mode, ?mock=true or X-Mock: true. Docs
  • New: DELETE /api/v1/results/:id to erase a stored result early. Docs
  • Changed: Enterprise price (5,000+ try-ons) lowered from $0.08 to $0.07. India stays at ₹6.50.
  • Changed: garment_url downloads are now checked at every redirect and at connection time; internal, private and cloud-metadata addresses are refused.
  • Docs: New multi-page docs with Markdown versions of every page, a Data Processing Agreement, and a resale permission in the Terms.

12 November 2026

  • Changed: New prices at every size: 50+ $0.11, 300+ $0.10, 1,000+ $0.09, 5,000+ $0.08.
  • New: Named API keys, up to 5 active, last-used dates, revoke one at a time.

5 November 2026

  • Changed: POST /generate always returns image/png, matching its documented Content-Type.