Skip to main content
POST
Preview a CSV import

Authorizations

Authorization
string
header
required

Secret API key, created in the dashboard under Settings → API. Send it as Authorization: Bearer rk_secret_… from your server only. Publishable keys (pk_live_…) are for the native SDKs and reach the capture endpoints alone. An unknown key returns 401.

Path Parameters

slug
string
required

Template slug — lowercase [a-z0-9-].

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"warehouse-intake"

Body

application/json
csv
string
required

Raw CSV text, header row first.

Minimum string length: 1
column_mapping
object

Optional explicit header→field mapping when automap falls short.

Response

Parse report — resolved mapping, valid/invalid rows, abort prediction.

column_mapping
object
required
ignored_columns
string[]
required
total_rows
integer
required
valid_rows
integer
required
invalid_rows
object[]
required
invalid_rows_total
integer
required
would_abort
boolean
required
preview
object[]
required