Skip to main content
POST
Preview a Database import

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Body

application/json
databaseName
string
required
storageEntryId
string<uuid>
required
format
enum<string>
required

Format of the data. Gzip sources such as .csv.gz use the same format value as their decoded contents.

Available options:
csv,
tsv,
ndjson,
xlsx
mode
enum<string>
required
Available options:
insert,
upsert
onError
enum<string>
required
Available options:
abort,
skipRow
skipNotification
boolean
default:false

Suppress import stage and review/terminal System messages and emails. Low-code defaults to true.

storageUploadSessionId
string<uuid>

Register validation before a browser upload starts. Must target storageEntryId and belong to the caller. The durable operation waits for upload finalization before validating; repeated admission of the same upload reuses the operation.

mapping
object

Source column to target database and column; null skips a source column.

Response

202