table-imports

Create the table and start loading its rows

Create the table and its columns from the reviewed mapping, then start the row load in the background.

The table exists as soon as this returns, so the client can navigate to it immediately and watch rows arrive. Poll the job to follow progress.

Committing twice is refused: the second call finds the import already running rather than creating a second table.

post/table-imports/{import_id}/commit/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/table-imports/{import_id}/commit/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

import_idstring uuid required

Request body

folder_idstring uuid nullable

The folder to make the table in, as when the file is imported from inside one on the Tables list. Leave it out for the top level.

max_rowsinteger nullable

How many of the file's data rows to write, counted from the top: 1 or more. Clamped by the plan's own ceiling, so this can only ever import less than the preview's importable_row_count, never more. Omit it, or send null, for every row the plan allows; that is also how a file with a header and no data rows is committed. Named for the user's choice, unlike the preview's row_limit, which is the plan's cap.

table_namestring required

Name for the table this creates.

Response

Successful Response

created_atstring date-time required
errorstring nullable required

Why the whole job failed, if it did.

failed_rowsinteger required

Rows that could not be written: the exact count.

idstring uuid required
imported_rowsinteger required

Rows written so far.

source_filenamestring required
status'pending' | 'running' | 'succeeded' | 'failed' required

Where a CSV import has got to.

PENDING is a parsed-and-stored upload the user has not committed yet: it holds an inferred mapping and nothing else. RUNNING means the table and its columns exist and the row job is inserting. The two terminal states are absorbing: a job never leaves them.

table_idstring uuid nullable required

The table this created; null before commit.

total_rowsinteger required

Rows this import will write: the file's rows, capped by the plan and by whatever max_rows the commit asked for, or the rows its row_ranges hold.

updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.