client.personas

A persona describes a simulated participant in the third person, as if briefing an actor. See Simulations.

list()

client.personas.list(study_id) -> PersonaListOut

Every persona for the study, newest first. Returns PersonaListOut.

client.personas.create(study_id, *, content: str, source: str | None = None) -> PersonaOut

Write a persona by hand.

str

required

Who the participant is (background, situation, attitudes), written as third-person prose.

str

default:"manual"

manual or generated.

Returns PersonaOut.

client.personas.update(study_id, persona_id, *, content: str) -> PersonaOut

Replace a persona’s description. Only affects future simulation runs. Returns PersonaOut.

client.personas.delete(study_id, persona_id) -> SuccessResponse

Delete a persona. Interviews already simulated with it are kept. Returns SuccessResponse.

client.personas.generate(study_id, *, count: int | None = None, save: bool | None = None) -> PersonaGenerateOut

Draft personas with AI from the study’s own context.

int

default:"1"

How many to generate, from 1 to 10.

bool

default:"True"

Save them to the study. Pass False to preview; previewed personas have no IDs.

Returns PersonaGenerateOut.