GET/designsmember

Swarm designs: the platform's templates (read-only: audience-test, ab-test, panel-delphi, diffusion) and the tenant's own, latest version of each.

Query

whopopulation | personas | selves
statusactive | retired | template
GET/designs/:keymember

A design at a version (?version=, default latest), its versions and its recent runs.

PUT/designs/:keyadmin

Save a design's next version (unchanged writes nothing), validated against its pack or its selves. Template keys are refused: start from one with from.

Body

name
purpose
froma template or design key to start from (spec fields given override it)
statusactive | retired
spec{who: {population: {pack, simulate, represents?, seed?, segments?, rake?} | personas: {pack, where?, limit?} | selves: [{handle, weight?, role?}], tiers?: {voiced?, surrogate?}}, structure?: {mixing?, graph?, homophily?, stubbornness?, seeding?: {share, who?}}, process?: {kind: one-off|rounds|debate|delphi (living: not yet), rounds?}, protocol?: {kind: ssr|stance-dist (populations) | vote|consensus|stance-dist|critique-revise (selves), threshold?}, time?: {step, horizon, report_every?, scale?, reference_date?}, stimulus?, variants?, ab?, measures?, voice?, dynamics?, observe?: {tool, args?, members?, max?}, calibration?: {targets: [{measure?, metric, target, tolerance?}]}, seeds?}
POST/designs/:key/runsmember

Run a design. Selves: a swarm run (any key). Population or personas: a simulation run in /sim/runs (admin key), or one per variant on the same seeds with a compare link.

Body

stimulus{text, kind?} (or the design's own)
variants[{label, text}] 2..3
seedoverride the population's seed
reference_dateYYYY-MM-DD
holdtrue: wait for observations, then release
versionrun an earlier version
questionselves: the question
choicesselves: 2..8
briefselves: background
POST/designs/:key/askmember

Bulk ask: one question to n members in one call. Selves: a weighted sample, each answer weighted by what it stands for. Population or personas (admin key): n voiced members, evenly or a weighted stratum sample, rated against the choices; partial results stream in the run's progress and sim.progress events.

Body

question
choicesoptional 2..11 strings
n1..500
strata[category dimensions or "segment"]
seed
briefselves: background
DELETE/designs/:idadmin

Delete every version of the tenant's own design (templates are never touched; runs keep their results), for good (404 when not the tenant's). Event design.deleted.

POST/designs/deleteadmin

Delete many designs at once; those not found come back under missing.

Body

ids[ids], 1..200
POST/designs/:id/archiveadmin

Archive (archived: true, the default) or bring back (false) a design. Archived designs leave lists unless ?archived=1 (only archived) or all.

Body

archivedtrue | false
POST/designs/archiveadmin

Archive or bring back many designs at once.

Body

ids[ids], 1..200
archivedtrue | false
A glass tree whose crown holds many small worlds like fruit

Which world will you live in?

What grows here is meant to reach the real world. Start with a world of your own.