Digital twins

POST /v2/simulation-studies/{study_id}/stop/ — stop a running simulation early.

Same scope, entitlement, and org-scoped lookup as launch, and the same unwrapped service body. Stopping twice is safe: a repeat while the run is still settling returns 202 again.

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

Request

  • Base URL: https://api.outset.ai
  • URL: https://api.outset.ai/v2/simulation-studies/{study_id}/stop/
  • 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

Response

Stop accepted; retention follows the completion threshold and no further twins are interviewed.

status'stopping' required
  • stopping - stopping

Changes

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