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
WireDataFrame · 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.

n_trials
integer
default:500
Required range: x >= 1
max_steps
integer
default:30
Required range: x >= 1
random_state
integer | null
default:42
explain_every
integer
default:1

Speed/quality knob: higher values speed up the search at some cost to scenario yield. Default 1 (highest quality).

Required range: x >= 1
check_every
integer
default:1

Speed/quality knob with higher leverage than explain_every: higher values speed up the search with a coarser stride. Default 1 (highest quality).

Required range: x >= 1
top_k_drivers
integer | null

Restrict each step to the K most influential features — yields sparser scenarios on wide feature spaces. None = no restriction. Avoid 1 (too restrictive).

Required range: x >= 1
constraints
Constraints · object

Response

Successful Response

job_id
required

Server-assigned id of the submitted job

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