client.simulations

See Simulations for polling patterns and running several at once.

run()

client.simulations.run(
    study_id,
    *,
    persona_id=None,
    persona: str | None = None,
    model_tier=None,
    deliver_signals: bool | None = None,
) -> SimulationStartOut

Start one simulated interview and return immediately. The run continues in the background: poll get() until status is completed or failed. Credits are reserved up front, and a run that would exceed your balance raises InsufficientCreditsError.

str | UUID

A stored persona to play the participant. Omit both this and persona for a generic participant.

str

Ad-hoc persona text, used when no persona_id is given.

str | ModelTier

default:"open_weights"

open_weights, standard or premium.

bool

Let the flow’s “Send a signal” steps reach their real endpoints.

Returns SimulationStartOut, which includes estimated_credits.

get()

client.simulations.get(simulation_id) -> SimulationOut

A run’s current state: status, interview_id, credits_used and any error. Returns SimulationOut.

list()

client.simulations.list(study_id, *, status: str | None = None, limit: int | None = None, offset: int | None = None) -> SimulationListOut

The study’s runs, newest first.

str

running, completed or failed.

int

default:"50"

Page size.

int

Page offset.

Returns SimulationListOut.

delete()

client.simulations.delete(simulation_id) -> None

Delete a finished run’s record. The interview it produced is kept.

Client

Study setup

Recruitment

Simulation

Results

Organization

Utilities

run()

get()

list()

delete()

​run()

​get()

​list()

​delete()

run()

get()

list()

delete()