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

# Get a workflow

> Read one workflow: its lines, settings, version and what is left to fix before it can run.

Returns one workflow. Its `lines` are what you edit and send back with [Replace a workflow’s steps](https://docs.orgo.ai/api-reference/workflows/replace.md), and its `version` (also the `ETag` header) is what you send back as `If-Match`.

## Path parameters

**id** `string` *required*

The workflow’s id, like `morning-report`, from [List workflows](https://docs.orgo.ai/api-reference/workflows/list.md).

## Response

**id** `string`

The workflow’s id.

**name** `string | null`

Its name.

**on** `boolean`

`true` when its start runs it.

**version** `integer`

The version. Send it as `If-Match` on a write.

**lines** `string`

The workflow, one JSON object per step, the start first. The format is at [orgo.ai/workflows.md](https://www.orgo.ai/workflows.md).

**settings** `object`

What it asks for once, name to value, like `{ "channel": "sales" }`.

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

What still has to be done before it can run, in plain words. Empty when it is ready.

**problems** `object[]`

The same, each with the `step` it is on and `say`. A setting to fill in is on the start.

## Example

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

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

r = requests.get(
    "https://www.orgo.ai/api/workflows/morning-report",
    headers={"Authorization": f"Bearer {os.environ['ORGO_API_KEY']}"},
)
workflow = r.json()
print(workflow["version"], workflow["to_fix"])
```

```javascript JavaScript theme={null}
const r = await fetch("https://www.orgo.ai/api/workflows/morning-report", {
  headers: { Authorization: `Bearer ${process.env.ORGO_API_KEY}` },
});
const workflow = await r.json();
```

### Response

```json theme={null}
{
  "id": "morning-report",
  "name": "Morning report",
  "on": false,
  "version": 3,
  "lines": "{\"id\":\"a\",\"kind\":\"start\",\"title\":\"9:00 AM\",\"sub\":\"Weekdays\",\"name\":\"Morning report\"}\n{\"id\":\"b\",\"after\":[\"a\"],\"kind\":\"agent\",\"agent\":\"hermes\",\"title\":\"Write the report\",\"task\":\"Write a short report on yesterday’s new customers.\"}\n{\"id\":\"c\",\"after\":[\"b\"],\"kind\":\"app\",\"app\":\"slack\",\"title\":\"Post\",\"where\":\"{channel}\",\"message\":\"{report}\"}",
  "settings": {},
  "to_fix": ["Fill in channel"],
  "problems": [{ "step": "a", "say": "Fill in channel" }]
}
```

## Errors

| Status | Code | When |
| - | - | - |
| `401` | | No key, or a key Orgo doesn’t know. |
| `403` | `key_permission` | A restricted key without Workflows read. |
| `404` | `not_found` | No workflow by that id. `next` says to list them with `GET /api/workflows`. |
| `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 GET /workflows/{id}
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}:
    get:
      tags:
        - Workflows
      summary: Get a workflow
      description: >-
        Its lines (what to edit and PUT back), settings, version (send it as
        If-Match on a write) and what to fix before it can run: to_fix in the
        person’s words, problems with the step each is on.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-z0-9-]{1,60}$
          example: morning-report
      responses:
        '200':
          description: The workflow.
          headers:
            ETag:
              description: The version, quoted.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
              example:
                id: morning-report
                name: Morning report
                'on': false
                version: 3
                lines: >-
                  {"id":"a","kind":"start","title":"9:00
                  AM","sub":"Weekdays","name":"Morning report"}

                  {"id":"b","after":["a"],"kind":"agent","agent":"hermes","title":"Write
                  the report","task":"Write a short report on yesterday’s new
                  customers."}

                  {"id":"c","after":["b"],"kind":"app","app":"slack","title":"Post","where":"{channel}","message":"{report}"}
                settings: {}
                to_fix:
                  - Fill in channel
                problems:
                  - step: a
                    say: Fill in channel
        '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:
    Workflow:
      type: object
      required:
        - id
        - name
        - 'on'
        - version
        - lines
        - settings
        - to_fix
        - problems
      properties:
        id:
          type: string
          pattern: ^[a-z0-9-]{1,60}$
        name:
          type:
            - string
            - 'null'
        'on':
          type: boolean
          description: Whether its start runs it. It is on only while it can run.
        version:
          type: integer
          description: Send it as If-Match on a write.
        lines:
          type: string
          description: >-
            The workflow, one JSON object per step, the start first
            (https://www.orgo.ai/workflows.md).
        settings:
          type: object
          additionalProperties:
            type: string
          description: What it asks for once, name to value.
        to_fix:
          type: array
          items:
            type: string
          description: >-
            What still has to be done before it can run, in the person’s words.
            Empty: ready.
        problems:
          type: array
          items:
            type: object
            properties:
              step:
                type: string
                description: 'The step it is on (empty: the whole workflow).'
              say:
                type: string
        turned_off:
          type: boolean
          description: This write left it unable to run, so it was turned off.
        dropped:
          type: array
          items:
            type: string
          description: What of the lines sent was left out or rewritten.
    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.