Digital twins

POST /v2/simulation-studies/{study_id}/launch/ — launch a simulation run.

Resolves the study through the org-scoped marker chain (404 on a foreign or missing id), reads an optional Idempotency-Key header (a malformed value 400s; absent, one is generated), and hands off to launch_simulation. The response body is the Simulate service's own contract — an accepted {requested, queued} or a refusal {status, errors} — so it is returned verbatim, not wrapped in the single-object envelope, mirroring the v1 simulate action.

post/v2/simulation-studies/{study_id}/launch/

Request

  • Base URL: https://api.outset.ai
  • URL: https://api.outset.ai/v2/simulation-studies/{study_id}/launch/
  • Auth: OAuth 2 (authorization code, authorization URL https://outset.ai/oauth/authorize, token URL https://api.outset.ai/users/oauth/token/, scopes: twins:launch)

Path parameters

study_idstring uuid required

Headers

Idempotency-Keystring uuid

Optional UUID that de-duplicates retries: replaying a key returns the original launch outcome instead of starting a second run. One is generated when omitted.

Response

Launch accepted; twin interviews queued.

requestedinteger required

Twins requested for this run.

queuedinteger required

Twin interviews actually queued. May be fewer than requested when the eligible twin pool (after consent and prior-run exclusions) is smaller.

Changes

No recorded changes to this operation across all 1 revision of this API.