Skip to main content
POST
Check a CSV before creating anything

Authorizations

Authorization
string
header
required

Tenant API key (vdx_live_…) as Authorization: Bearer.

Query Parameters

assistantId
string<uuid>

Required unless given in the JSON body.

Body

csv
string
required
assistantId
string<uuid>
mapping
object

Corrections to auto-detection, keyed by the header as written: to, rowRef, assistantId, from, var:<name> for a prompt variable, or "" to ignore the column. Columns left out are detected as usual. Where two columns claim one single-valued field the leftmost keeps it, and the resolved mapping comes back in the response.

Response

The verdict — including when every row is bad. Previewing a broken file is a successful preview, and the counts are the answer.

headers
string[]

The file's columns, in its own order.

mapping
object

What each column was read as, after corrections.

total
integer

Rows under the header, blank lines excluded.

valid
integer

Rows that would be dialled.

errorRows
integer

Parse failures plus rejections.

duplicates
integer

Rows whose to appeared on an earlier line. Dialled anyway.

errors
object[]

Every problem row, capped at 5,000 entries.

errorsTruncated
boolean

More problems than errors lists. The counts stay exact.

sample
object[]

The first 50 lines in file order, each with its verdict.