How to use this API
Authentication. Every endpoint requires an X-API-Key header. This documentation page is the only public route.
Synchronous vs. webhook. A POST runs synchronously and returns the result in the response — unless you include a webhook_url, in which case you get an immediate 202 and the finished result is POSTed to that URL when the job completes.
Passthrough. Any field you add that the endpoint doesn't define — or an explicit passthrough object — is returned unchanged in the response and webhook, so you can correlate jobs downstream.
Note. This page builds payloads for you to copy; it does not send requests. Pick an endpoint on the left to begin.