/designsmemberSwarm designs: the platform's templates (read-only: audience-test, ab-test, panel-delphi, diffusion) and the tenant's own, latest version of each.
Query
who | population | personas | selves |
status | active | retired | template |
API ยท 9 operations
Everything a self, a population or a world is made of, declared in one place.
/designsmemberSwarm designs: the platform's templates (read-only: audience-test, ab-test, panel-delphi, diffusion) and the tenant's own, latest version of each.
Query
who | population | personas | selves |
status | active | retired | template |
/designs/:keymemberA design at a version (?version=, default latest), its versions and its recent runs.
/designs/:keyadminSave 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 | |
from | a template or design key to start from (spec fields given override it) |
status | active | 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?} |
/designs/:key/runsmemberRun 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 |
seed | override the population's seed |
reference_date | YYYY-MM-DD |
hold | true: wait for observations, then release |
version | run an earlier version |
question | selves: the question |
choices | selves: 2..8 |
brief | selves: background |
/designs/:key/askmemberBulk 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 | |
choices | optional 2..11 strings |
n | 1..500 |
strata | [category dimensions or "segment"] |
seed | |
brief | selves: background |
/designs/:idadminDelete 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.
/designs/deleteadminDelete many designs at once; those not found come back under missing.
Body
ids | [ids], 1..200 |
/designs/:id/archiveadminArchive (archived: true, the default) or bring back (false) a design. Archived designs leave lists unless ?archived=1 (only archived) or all.
Body
archived | true | false |
/designs/archiveadminArchive or bring back many designs at once.
Body
ids | [ids], 1..200 |
archived | true | false |

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