Skip to main content
POST
Upload a CSV and preview the table it would create

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
file
file
required

The CSV file to import.

Response

Successful Response

What an upload returns: a mapping to review, and enough of the file to judge it.

Nothing is created yet — no table, no columns, no rows. Edit the mapping and POST it to the commit endpoint to actually build the table.

When importable_row_count is below estimated_row_count the file is longer than the plan allows and the import will take its first importable_row_count rows. Say so before the user commits: the two numbers are here as numbers, rather than as a sentence in warnings, because the client puts its upgrade control beside them.

columns
ImportPreviewColumnSchema · object[]
required

The inferred mapping.

estimated_row_count
integer
required

Data rows in the file, excluding the header.

import_id
string<uuid>
required

Identifies this upload through commit and polling.

importable_row_count
integer
required

How many of those rows the import will write, once the cap is applied.

row_limit
integer
required

Rows one table may hold on this organisation's plan.

sample_rows
string[][]
required

Raw sampled rows, in file order.

warnings
string[]
required

Non-fatal things the user should see.