Information
- OpenAPI version:
3.1.0
Overview
One engine, one job model, one bill — the unified Figur production API.
Figur API 1.0.0
Section titled “Figur API 1.0.0”The public Figur API: a single flat, named-typed /v1/* surface over one job model. Eleven peer workflows dispatch through POST /v1/<workflow> (try-on, extract, look, model-generator, the product-to-model composes, and the background/model swaps), all returning a uniform 202 { request_id, job_id, status, credits_cost }. Poll progress through the unified reads — /v1/jobs*, /v1/renders* — and use the support surface for uploads, catalog + garment-category reference data, the pre-dispatch compatibility check, and billing (/v1/credits, /v1/usage).
Every call authenticates with an sk_* API key (Bearer). Credits gate every dispatch and are refunded automatically on any failure path. All non-2xx responses share one envelope: {"error": {"code": "...", "message": "...", "request_id": "..."}}.
This schema is the single source of truth for the TypeScript SDK and the published docs — only the public /v1/* surface is documented here.
Authentication
Section titled “ Authentication ”Security scheme type: http