Runs

Stop a run

Request the platform stop a non-terminal, stoppable run. The stop is asynchronous — poll GET /v1/runs/{runId} to observe the terminal STOPPED status.

post/v1/runs/{runId}/stop

Path parameters

runIdstring required

Run identifier (ULID).

Example:01JGXYZABCDEFGHJKMNPQRSTVW

Run identifier (ULID).

Response

Stop requested (asynchronous)

runIdstring required
status'STOPPING' required

Always the literal STOPPING (UPPERCASE, case-sensitive) — the stop is accepted; poll GET /v1/runs/{runId} until STOPPED.

messagestring required

Changes

Changed in 3 of the 22 revisions of this API.705

    • ●

      added the new IDENTITY_ALREADY_LINKED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_ALREADY_LINKED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_ALREADY_LINKED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_ALREADY_LINKED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_ALREADY_LINKED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_RATE_LIMITED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_RATE_LIMITED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_RATE_LIMITED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_RATE_LIMITED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_RATE_LIMITED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_REQUIRES_SESSION enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_REQUIRES_SESSION enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_REQUIRES_SESSION enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_REQUIRES_SESSION enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_REQUIRES_SESSION enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_STATE_INVALID enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_STATE_INVALID enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_STATE_INVALID enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_STATE_INVALID enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_LINK_STATE_INVALID enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_PROVIDER_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_PROVIDER_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_PROVIDER_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_PROVIDER_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_PROVIDER_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_PROVIDER_UNKNOWN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_PROVIDER_UNKNOWN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_PROVIDER_UNKNOWN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_PROVIDER_UNKNOWN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_PROVIDER_UNKNOWN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_USER_ALREADY_LINKED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_USER_ALREADY_LINKED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_USER_ALREADY_LINKED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_USER_ALREADY_LINKED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_USER_ALREADY_LINKED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_VERIFICATION_FAILED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_VERIFICATION_FAILED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_VERIFICATION_FAILED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_VERIFICATION_FAILED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_VERIFICATION_FAILED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new INSUFFICIENT_SCOPE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new INSUFFICIENT_SCOPE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new INSUFFICIENT_SCOPE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new INSUFFICIENT_SCOPE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new INSUFFICIENT_SCOPE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROMO_IDENTITY_REDEEMED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROMO_IDENTITY_REDEEMED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROMO_IDENTITY_REDEEMED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROMO_IDENTITY_REDEEMED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROMO_IDENTITY_REDEEMED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROMO_REDEEM_REQUIRES_SESSION enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROMO_REDEEM_REQUIRES_SESSION enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROMO_REDEEM_REQUIRES_SESSION enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROMO_REDEEM_REQUIRES_SESSION enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROMO_REDEEM_REQUIRES_SESSION enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new WALLET_INSUFFICIENT_FUNDS enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new WALLET_INSUFFICIENT_FUNDS enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new WALLET_INSUFFICIENT_FUNDS enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new WALLET_INSUFFICIENT_FUNDS enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new WALLET_INSUFFICIENT_FUNDS enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new X402_UNBOUNDED_PRICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new X402_UNBOUNDED_PRICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new X402_UNBOUNDED_PRICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new X402_UNBOUNDED_PRICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new X402_UNBOUNDED_PRICE enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added