Endpoints

Converts input file into structured design data.

See Overview for what each input and output format means and which combinations are supported, and Pricing for what they cost.

Asynchronous conversions. Conversions run as background jobs, so POST /convert returns 202 Accepted with a Location header pointing at a poll endpoint (GET /convert/jobs/{jobId}). Poll that endpoint until its JSON status is done (with a short-lived resultUrl to download the result) or error. The resultUrl is a JSON body for every format except image, which delivers a ZIP. Because the conversion has not started when the 202 is returned, an input the server can't read (a corrupt .fig, unreadable HTML) surfaces as a job error on the poll rather than a 400 on the submit. Billing is reserve-then-settle: an estimate is held up front and reconciled to the real cost when the job finishes; a run that produces no output is refunded.

Note:

• When input property is used, input.data (base64 bytes) or input.url must be set.
• In multipart mode the uploaded file field replaces both, so input itself is omitted.
• Requests are capped at 30 MB total (and base64 inflates data by ~33%). For larger files use POST /convert/upload to upload out of band, then convert by input.url = "upload://{id}".

Upload a large source file out of band, for files over the 30 MB POST /convert request cap (up to 2 GB). Free — billing happens on the /convert call that consumes the upload.

Flow:

1. POST /convert/upload with the exact byte size → { uploadUrl, ref }.
2. PUT the raw bytes to uploadUrl with Content-Type: application/octet-stream and a Content-Length matching size exactly (the signed URL is pinned to both, and expires after 10 minutes).
3. POST /convert with input.url set to the returned ref (upload://{id}), plus format/name/range… as usual.

Uploads are private to the API key that created them — a ref used by anyone else 404s on /convert.

Poll an asynchronous /convert job — the URL from the Location header of the 202 on POST /convert. Always 200 with a status envelope; poll until status is done or error (job failure is not an HTTP error). Authenticate with the same API key (or Authorization: Bearer) that started the job. The job is pollable for 7 days.