Skip to main content
POST
Create a feature refinement

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Human-readable run name, unique per user. Letters, digits, spaces, hyphen and underscore only, 1–100 characters. Rejected with 400 otherwise — note that punctuation such as angle brackets, dots or slashes is not allowed.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9 _-]{1,100}$
Example:

"German Credit Risk"

trainFileName
string | null

Original filename of the training CSV the user selected. Optional metadata, echoed back on the run so the source dataset is identifiable beyond the run name.

Maximum string length: 260
Example:

"german-credit-train.csv"

testFileName
string | null

Original filename of the labelled-test CSV the user selected. Optional, echoed back on the run.

Maximum string length: 260
Example:

"german-credit-test.csv"

numberOfBuckets
integer
default:20

Bucketing granularity (NoB), the one refinement hyperparameter this endpoint accepts. Must be 4, 10 or 20; any other value is rejected with 400. Defaults to 20 when omitted. 10 is the recommended starting point. Higher granularity can improve refinement accuracy at the cost of a longer run.

Response

Feature refinement created

featureRefinementKey
string<uuid>
required
status
string
required
uploadTargets
object[]
required
startUrl
string
required
progressUrl
string