HomeGuidesAPI Reference
API Reference

Import records

This endpoint allows clients to submit data entries for a dataset, including fields that require file uploads. When a data entry includes a file field (e.g., "passport": "file.jpg"), the API responds with a unique id for the entry and a presigned URL for uploading the file directly to AWS S3.

Upsert by "reference": records are matched to existing client records only by their "reference". If a data entry includes a "reference" that already exists in the workspace, that record is updated in place and keeps its original "spektrId"; otherwise a new record is created with a newly generated "spektrId". A "reference" must be a non-empty string, cannot be the literal value "root", and must be unique across the workspace — duplicate references (repeated within the same batch or already assigned to another record) are rejected with 409 Conflict. Entries sent without a "reference" are always created as new.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the dataset

Body Params

The request body should be a JSON object containing a "data" array. Each item in the array represents a data entry and should include fields as defined in your dataset schema ("first_name", "age", "passport") or workspace fields. For file fields like "passport", include the key with a string value. Each item may also include an optional top-level "reference" string. The "reference" field is reserved and may be sent even if it is not declared in the dataset schema; it is always accepted and stored. Any other field that is not part of the dataset schema or workspace fields is rejected.

data
array of objects
required

A list of records, where each record represents an individual entry. Each record is a dictionary with specific key-value pairs.

data*
Headers
string

Optional unique key (1–255 chars) to ensure the request is processed only once. If a duplicate key is sent with the same request parameters, the original response is replayed. Replayed responses include the idempotent-replayed: true header.

Responses

409

A request with this idempotency-key is currently being processed

422

idempotency-key has already been used with different request parameters

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json