Skip to main content
POST
Scenario

Authorizations

Authorization
string
header
required

An API key or OAuth2/OIDC access token sent as Authorization: Bearer <token>.

Path Parameters

model_id
string<uuid>
required

Body

application/json
dataframe
WorkspaceQuery · object
required

Inline dataset spec — each materialized row is one query for the scenario search. Caps on row count are enforced inside the worker after materialize().

target_value
number
required

Score the search drives each query's prediction to cross. In label units for regression; the positive-class probability in (0, 1) for binary classification (e.g. 0.5 flips to the other side of the decision boundary). Each query travels in whichever direction reaches it.

Budget, stopping, sparsity, and reproducibility for scenario search.

constraints
Constraints · object
numeric_quantiles
Numeric Quantiles · tuple
structural_constraints
(CategoryHierarchySchema · object | CategoryCompatibilitySchema · object)[]

Response

Successful Response

job_id
required

Server-assigned id of the submitted job

status
enum<string>
required
Available options:
pending,
running,
completed,
failed,
cancelled
message
string
required