> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orgo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Stop a run

> Stop a run wherever it is: mid-step, between tries, or waiting. What it runs on the computer is ended.

Stops a run wherever it is: mid-step, between tries, or waiting at Check with me. What its step runs on the computer is ended, without waking the computer. Steps that already ran stay as they ran; nothing is undone, and a send already under way may still land.

## Path parameters

**id** `string` *required*

The workflow’s id, like `morning-report`.

**runId** `string` *required*

The run’s `run_id`.

## Headers

**X-Agent** `string`

Who stopped it, at most 30 characters, like `Claude Code`.

## Response

**run** `object`

The run, as [Get a run](https://docs.orgo.ai/api-reference/workflows/get-run.md) describes it, with `state` `stopped`.

## Example

```bash cURL theme={null}
curl -X POST https://www.orgo.ai/api/workflows/morning-report/runs/$RUN_ID/stop \
  -H "Authorization: Bearer $ORGO_API_KEY"
```

```python Python theme={null}
import os, requests

r = requests.post(
    f"https://www.orgo.ai/api/workflows/morning-report/runs/{run_id}/stop",
    headers={"Authorization": f"Bearer {os.environ['ORGO_API_KEY']}"},
)
print(r.json()["run"]["state"])
```

```javascript JavaScript theme={null}
await fetch(`https://www.orgo.ai/api/workflows/morning-report/runs/${runId}/stop`, {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.ORGO_API_KEY}` },
});
```

Replace `$RUN_ID` with the run’s `run_id`.

## Errors

| Status | Code | When |
| - | - | - |
| `401` | | No key, or a key Orgo doesn’t know. |
| `403` | `key_permission` | A restricted key without Workflows write. |
| `404` | `not_found` | No workflow, or no run, by that id. |
| `404` | (no body) | Workflows aren’t open to your account. |
| `409` | `run_not_going` | The run already ended. The body carries the `run`. |
| `429` | `rate_limited` | Too many requests. Carries `Retry-After`. |
| `503` | `runs_unavailable` | Runs can’t be changed here right now. Retry after a minute. |
| `503` | | Orgo couldn’t verify the key because of a server-side fault. Retry. |


## OpenAPI

````yaml POST /workflows/{id}/runs/{runId}/stop
openapi: 3.1.0
info:
  title: Orgo API
  description: >-
    Launch cloud computers that AI agents can control and interact with. Create
    workspaces, provision computers, and control them programmatically.
  version: 2.0.0
  contact:
    name: Orgo Support
    email: contact@orgo.ai
    url: https://orgo.ai
servers:
  - url: https://www.orgo.ai/api
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Support
    description: >-
      Orgo’s support agent, for programs: ask how to do something in Orgo and
      get an answer with full URLs and copyable commands.
  - name: Account
    description: >-
      Account capacity: how many computers an account may run, and adding or
      giving back more.
  - name: Agent accounts
    description: >-
      Accounts an AI agent makes for itself, and the claim link a person uses to
      take one over.
  - name: Clients
    description: >-
      Run Orgo for your clients from your own app: a workspace and scoped key
      each, billed to you or to them.
  - name: Workspaces
    description: Organize computers into named workspaces
  - name: Computers
    description: Provision and manage virtual computers
  - name: Computer Lifecycle
    description: Start, stop, and restart computers
  - name: Computer Actions
    description: Control mouse, keyboard, and execute commands
  - name: Screens
    description: >-
      More than one desktop on a single computer. Each screen is its own X
      server with its own cursor and window manager, so an agent working on one
      cannot disturb another.
  - name: Files
    description: Upload and download files
  - name: Templates
    description: Author, build, and launch reproducible computers from templates
  - name: Chat
    description: Run an agent on a computer through OpenAI-compatible chat completions.
  - name: Workflows
    description: >-
      Routines that run the same way every time: a start, then steps. Make them
      from plain words or lines, check them, run them and follow their runs (in
      preview).
paths:
  /workflows/{id}/runs/{runId}/stop:
    post:
      tags:
        - Workflows
      summary: Stop a run
      description: >-
        Wherever it is: mid-step, between tries, or waiting. What it runs on the
        computer is ended.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-z0-9-]{1,60}$
          example: morning-report
        - name: runId
          in: path
          required: true
          schema:
            type: string
        - name: X-Agent
          in: header
          required: false
          schema:
            type: string
            maxLength: 30
          description: Who you are, as the canvas names you (like Claude Code).
      responses:
        '200':
          description: '{ run }, stopped.'
          content:
            application/json:
              schema:
                type: object
                required:
                  - run
                properties:
                  run:
                    $ref: '#/components/schemas/WorkflowRun'
              example:
                run:
                  run_id: 0d9c6c1e-5b8e-4a59-9d3b-7a1f2c3d4e5f
                  state: stopped
                  at: 1793887204000
                  by: Claude Code
                  inputs: {}
                  steps:
                    - id: a
                      title: 9:00 AM
                      kind: start
                      how: ran
                      ms: 4
                      output: {}
                    - id: b
                      title: Write the report
                      kind: agent
                      how: ran
                      ms: 21400
                      output:
                        report: 3 new customers yesterday.
                  output:
                    report: 3 new customers yesterday.
                  finished_at: '2026-11-05T14:00:31.000Z'
        '401':
          description: Unauthenticated (with WWW-Authenticate and docs).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowError'
        '403':
          description: >-
            A key without Workflows access at this level (key_permission); a key
            that may not act on the workflow’s computer (key_permission: Control
            write and AI write, or computer_key_held).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowError'
        '404':
          description: >-
            No workflow (or run) by that id (not_found); a bare 404 with no body
            where Workflows are not open to the account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowError'
        '409':
          description: It already ended (run_not_going, with run).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          description: >-
            Runs can’t happen here right now (runs_unavailable), with
            Retry-After. Also when Orgo could not verify the credential because
            of a server-side fault (with Retry-After: 5).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowError'
components:
  schemas:
    WorkflowRun:
      type: object
      required:
        - run_id
        - state
      properties:
        run_id:
          type: string
        state:
          type: string
          enum:
            - running
            - waiting
            - done
            - stopped
            - needs_review
        at:
          type: integer
          description: When it started, in milliseconds since 1970.
        by:
          type: string
          description: Who started it.
        inputs:
          type: object
        steps:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              title:
                type: string
              kind:
                type: string
              how:
                type: string
              ms:
                type: integer
              output: {}
        output:
          description: What the last step to run handed on.
        waiting:
          type: object
          description: >-
            The step it waits at: id, title, asks (a person’s), agent and until
            (another agent’s).
        stop:
          type: object
          description: Why it stopped, and the one thing that fixes it.
        finished_at:
          type:
            - string
            - 'null'
          format: date-time
    WorkflowError:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
        code:
          type: string
        say:
          type: string
          description: The same, short, for a person.
        next:
          type: string
          description: The call that fixes it.
        to_fix:
          type: array
          items:
            type: string
        problems:
          type: array
          items:
            type: object
        version:
          type:
            - integer
            - 'null'
          description: 'version_conflict: the newest version.'
        lines:
          type:
            - string
            - 'null'
          description: 'version_conflict: the newest lines, to merge into.'
    RateLimited:
      type: object
      required:
        - error
        - code
        - limit
        - retry_after
      properties:
        error:
          type: string
          description: Which limit, in plain words, and when to try again.
        code:
          type: string
          const: rate_limited
        limit:
          type: string
          enum:
            - computer_create_per_minute
            - computer_create_per_hour
            - computer_create_per_day
            - computer_lifecycle_per_minute
            - computer_lifecycle_per_computer_per_minute
            - computer_control_per_minute
            - computer_control_per_computer_per_minute
            - chat_runs_per_minute
            - chat_runs_concurrent
            - workspace_create_per_hour
            - api_other_per_minute
        retry_after:
          type: integer
          minimum: 1
          description: Seconds to wait.
      example:
        error: >-
          Too many API requests this minute (120 a minute on your plan). Try
          again in 12 seconds.
        code: rate_limited
        limit: api_other_per_minute
        retry_after: 12
  responses:
    RateLimited:
      description: >-
        Over one of the account's plan rate limits (`rate_limited`): `limit`
        names it, and `retry_after` and `Retry-After` say how many seconds to
        wait. Limits are per account, the workspace owner's when the request
        acts on a computer or a workspace, and set by its plan. See [Account
        limits and rate limits](/guides/account-limits#plan-rate-limits).
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimited'
  headers:
    RetryAfter:
      description: Seconds to wait before asking again.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: The tightest limit this request counts against.
      schema:
        type: integer
    RateLimitRemaining:
      description: How many are left of it in this window.
      schema:
        type: integer
    RateLimitReset:
      description: Seconds until its window starts again.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key authentication. Get your key at orgo.ai/workspaces

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.