Skip to main content
POST
cURL

Path Parameters

dataset_pk
string<uuid>
required
version_pk
string<uuid>
required

Body

POST /datasets/.../preprocess — open-shape preprocessing parameters.

The schema of parameters is open-shape JSON: each preprocessing module owns and validates the shape of its own parameters.

Two layered size caps apply; requests exceeding either cap are rejected with 400:

  • PARAMETERS_MAX_BYTES caps the encoded JSON of parameters as a whole — a guard against runaway payloads.
  • MAX_RAW_TEXT_BYTES caps the raw_text carrier specifically. The tabular module reads file contents from parameters['raw_text'], so this cap applies at much larger sizes than the general parameters cap. Tunable via the DATAERAI_MAX_RAW_TEXT_BYTES env var for self-hosted deployments (e.g. to let dev fixtures override the default).
parameters
any

Response

202 - application/json
id
string<uuid>
required
read-only
status
enum<string>
required
  • QUEUED - Queued
  • RUNNING - Running
  • SUCCEEDED - Succeeded
  • FAILED - Failed
  • CANCELLED - Cancelled
Available options:
QUEUED,
RUNNING,
SUCCEEDED,
FAILED,
CANCELLED
job_runner_id
string
required
read-only
queued_at
string<date-time>
required
read-only
started_at
string<date-time> | null
required
read-only
completed_at
string<date-time> | null
required
read-only
parameters
any
required