Runs

Stop a run

Changed on

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

Request

  • Base URL: https://api.monid.ai
  • URL: https://api.monid.ai/v1/runs/{runId}/stop
  • Auth: HTTP bearer

Path parameters

runIdstring required

Run identifier (ULID).

Example:01JGXYZABCDEFGHJKMNPQRSTVW

Headers

X-Monid-Agent-Modelstring

Model driving the calling agent. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

X-Monid-Agent-Harnessstring

Agent harness or client making the call (e.g. a coding agent, an agent framework). Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

X-Monid-Agent-Session-Idstring

Caller-side session identifier, so the calls of one agent session (discover → inspect → run → polling) can be correlated. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

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

  • 631143e91790Revision changes
    • info

      added the new optional header request parameter X-Monid-Agent-Harness

    • info

      added the new optional header request parameter X-Monid-Agent-Model

    • info

      added the new optional header request parameter X-Monid-Agent-Session-Id

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

  • b944bb23906cRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the non-success response with the status