> ## 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.

# Validate a workflow

> Prove a workflow will work before it runs, step by step, and send nothing.

Checks each step of a workflow now and sends nothing. It looks at the workflow’s computer (without waking it), each agent installed there, each app signed in (with a read that proves it), the channels and sheets it names, the secrets its scripts read (by name only) and your credit. Validate before you turn a workflow on, and after you change it.

A step that would fail answers `say` (what is in the way, in a sentence) and `fix` (the one thing that fixes it).

## Path parameters

**id** `string` *required*

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

## Headers

**Accept** `string`

`text/event-stream` streams each step as it is known (`event: step`), then the whole answer (`event: done`). Anything else answers JSON once every step is checked.

## Response

**ok** `boolean`

`true` when every step will work.

**steps** `array`

Each step’s answer.

**Step**

**step** `string`

The step’s id.

**ok** `boolean`

`true` when it will work.

**say** `string`

When `ok` is `false`: what is in the way.

**fix** `object`

When `ok` is `false`: the one thing that fixes it. `action` is one of `reconnect` (connect the app on the computer), `edit` (change the step), `secrets`, `setup` (set the agent up on the computer), `credits` or `check`, with what it needs, like `app` and `label`.

**to\_fix** `string[]`

What to do, in plain words, one item per fix.

## Example

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

```bash Stream theme={null}
curl -N -X POST https://www.orgo.ai/api/workflows/morning-report/validate \
  -H "Authorization: Bearer $ORGO_API_KEY" \
  -H "Accept: text/event-stream"
```

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

r = requests.post(
    "https://www.orgo.ai/api/workflows/morning-report/validate",
    headers={"Authorization": f"Bearer {os.environ['ORGO_API_KEY']}"},
)
result = r.json()
for s in result["steps"]:
    if not s["ok"]:
        print(s["step"], s["say"])
```

### Response

```json theme={null}
{
  "ok": false,
  "steps": [
    { "step": "a", "ok": true },
    { "step": "b", "ok": false, "say": "Slack isn’t connected on this computer.", "fix": { "action": "reconnect", "app": "slack", "label": "Connect Slack" } }
  ],
  "to_fix": ["Connect Slack"]
}
```

### Stream

```text theme={null}
event: step
data: {"step":"a","ok":true}

event: done
data: {"ok":true,"steps":[{"step":"a","ok":true}],"to_fix":[]}
```

## Errors

| Status | Code | When |
| - | - | - |
| `401` | | No key, or a key Orgo doesn’t know. |
| `403` | `key_permission` | A restricted key without Workflows read, or without Control write and AI write for a workflow that has a computer. |
| `403` | `computer_key_held` | A restricted or expiring key, and the workflow’s computer holds its own Orgo key. |
| `404` | `not_found` | No workflow by that id. |
| `404` | (no body) | Workflows aren’t open to your account. |
| `429` | `rate_limited` | Your plan’s rate limit for other API calls. Carries `Retry-After`. |
| `503` | | Orgo couldn’t verify the key because of a server-side fault. Retry. |


## OpenAPI

````yaml POST /workflows/{id}/validate
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}/validate:
    post:
      tags:
        - Workflows
      summary: Check a workflow will work, sending nothing
      description: >-
        Each step looked at now on its computer and apps (connected, allowed to
        send, the channel or sheet it names there), and nothing sent. A step
        that says no has say (what is in the way) and fix (the one thing that
        fixes it). With Accept: text/event-stream it streams `event: step` as
        each is known, then `event: done` with the whole answer. A workflow with
        a computer takes a key with Control write and AI write too.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-z0-9-]{1,60}$
          example: morning-report
      responses:
        '200':
          description: Each step’s answer (or the stream).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowValidation'
              example:
                ok: false
                steps:
                  - step: a
                    ok: true
                  - step: b
                    ok: false
                    say: Slack isn’t connected on this computer.
                    fix:
                      action: reconnect
                      app: slack
                      label: Connect Slack
                to_fix:
                  - Connect Slack
            text/event-stream:
              schema:
                type: string
              example: |+
                event: step
                data: {"step":"a","ok":true}

                event: done
                data: {"ok":true,"steps":[{"step":"a","ok":true}],"to_fix":[]}

        '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'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/AuthUnavailable'
components:
  schemas:
    WorkflowValidation:
      type: object
      required:
        - ok
        - steps
      properties:
        ok:
          type: boolean
        steps:
          type: array
          items:
            type: object
            required:
              - step
              - ok
            properties:
              step:
                type: string
              ok:
                type: boolean
              say:
                type: string
                description: What is in the way.
              fix:
                type: object
                description: >-
                  The one thing that fixes it: action (reconnect, edit, secrets,
                  setup, credits, check) and what it needs.
        to_fix:
          type: array
          items:
            type: string
    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
    Error:
      type: object
      description: >-
        The base error body. Every failure carries `error`; individual endpoints
        add the fields named in the schemas below.
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable message.
          example: Access denied
        code:
          type: string
          description: >-
            Machine-readable reason. Present on the failures that define one,
            absent otherwise.
  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'
    AuthUnavailable:
      description: >-
        Orgo could not verify the credential because of a server-side fault,
        such as a database outage. Retry after `Retry-After`. Do not rotate the
        key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: >-
              Service temporarily unavailable. The database is not accepting
              requests. Retry shortly.
      headers:
        Retry-After:
          description: Seconds to wait before retrying. Always `5`.
          schema:
            type: string
            example: '5'
  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.