Skip to main content
POST
Preflight a file

Authorizations

Authorization
string
header
required

Your secret key as a bearer token, e.g. Authorization: Bearer sk_live_…. Secret keys are server-side only.

Body

application/json

Submit one or more files for preflight. By default the response is 201 Accepted and the job runs asynchronously. Set sync: true to wait up to ~27 s for the result (200 on completion, 202 + pending: true on timeout). An optional webhook is called when the job reaches a terminal status regardless of sync mode.

sources
any[]
required

List of files to preflight. Each becomes its own Task under a single Job. Even a single file must be wrapped in an array.

Required array length: 1 - 50 elements
sync
boolean
default:false

When true, the request waits for the job to complete (up to ~27 s). Returns 200 with { job } on success, or 202 with pending: true on timeout. The default is false (async 201).

webhook
any
metaData
any

Response

Sync completion (sync: true)

job
object