Skip to content
TryOn Docs

Overview

TryOn Public API 1.0

Section titled “TryOn Public API 1.0”

TryOn Public API

Manage your products and virtual try-on programmatically. This API is for merchants using the TryOn merchant panel (WooCommerce, custom platforms, and other non-Shopify stores).

Full documentation: https://docs.tryonvirtual.com

The sections below (auth, rate limits, error envelope) are the reference essentials. Everything else — setup steps, the try-on lifecycle, and storefront embedding — lives at the links above.

Authentication

Every request needs your API key in the Authorization header: Authorization: Bearer tryon_sk_.... Keys are created and revoked in the panel by admin users (max 10 active keys).

Rate limits

120 requests per minute per API key. Exceeding it returns 429 with a Retry-After header.

Errors

All errors share one envelope:

{"error": {"code": "not_found", "message": "Product not found"}}

Codes: unauthorized, not_found, validation_error, rate_limited, invalid_url, unreachable_url, not_an_image, too_large.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/products
POST
/products
GET
/products/{product_id}
DELETE
/products/{product_id}
PATCH
/products/{product_id}
POST
/products/{product_id}/images
DELETE
/products/{product_id}/images/{image_id}
GET
/usage

Authentication

Section titled “Authentication”

apiKey

Section titled “apiKey”

API key from panel Settings → API Keys.

Security scheme type: http

Bearer format: tryon_sk_...