API reference
A human-readable map of the Closku API resource groups, supported actions, and how to use them. Use this page to orient your integration work.
Resource groups
The Closku API is organized around the following resource groups:
| Group | Base path | Purpose |
|---|---|---|
| Try-Ons | /v1/try-ons | Submit and track virtual try-on requests |
| Catalog | /v1/catalog | Manage product data and images |
| Orders | /v1/orders | Query try-on order status and history |
| Usage | /v1/usage | Check current try-on counts and plan limits |
| Webhooks | /v1/webhooks | Configure webhook endpoints and manage subscriptions |
Common patterns
All API requests follow consistent conventions. The base URL is https://api.closku.io/v1. Authentication uses a Bearer token in the Authorization header, and the content type is always application/json. Include an Idempotency-Key header for safe retries. List endpoints use cursor-based pagination via cursor and limit parameters. Rate limits are planned for a future release. Contact support for current throughput guidance.
Reference posture
This reference is intentionally interpretation-first. Use it to orient your integration work, then pair it with the workflow pages when the surrounding behavior matters. Start with the Getting Started page for the integration sequence, refer to Authentication for credential details, use Orders and Webhooks to understand lifecycle events, and review Errors and Reliability for failure handling patterns. If an action feels ambiguous, return to the workflow page that explains why the action exists and when it should be used.
Next steps
Related pages
Integration sequence overview.
Error handling and debugging.