> ## 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. # Follow a workflow > A stream of a workflow’s changes and its runs as they move, as server-sent events. Opens a `text/event-stream` of one workflow: its steps changing, it being turned on or off, renamed or deleted, and every run moving step by step. The canvas follows a workflow the same way. The stream closes after 5 minutes. Open it again: an `EventSource` does that by itself, after the `retry: 1000` the stream sends. At most 10 streams are open at once per credential, and 5 per workflow; one more answers `429`. ## Path parameters **id** `string` *required* The workflow’s id, like `morning-report`. ## Events | Event | Data | When | | - | - | - | | (unnamed) | `{ lines, by, changed }` | Its steps changed. `by` names who wrote them. | | `state` | `{ on, settings, name, by, changed }` | It was turned on or off, renamed, or its settings changed. `changed` holds only what changed. | | `run` | `{ run, by }` | A run moved. `run` has the shape [Get a run](https://docs.orgo.ai/api-reference/workflows/get-run.md) describes. | | `deleted` | `{ by }` | It was deleted. | Lines that start with `:` are comments that keep the connection open. ## Example ```bash cURL theme={null} curl -N https://www.orgo.ai/api/workflows/morning-report/events \ -H "Authorization: Bearer $ORGO_API_KEY" ``` ```javascript JavaScript theme={null} const r = await fetch("https://www.orgo.ai/api/workflows/morning-report/events", { headers: { Authorization: `Bearer ${process.env.ORGO_API_KEY}` }, }); const reader = r.body.pipeThrough(new TextDecoderStream()).getReader(); for (;;) { const { value, done } = await reader.read(); if (done) break; process.stdout.write(value); } ``` ### Stream ```text theme={null} retry: 1000 : open event: run data: {"run":{"run_id":"0d9c6c1e-5b8e-4a59-9d3b-7a1f2c3d4e5f","state":"running"},"by":"You"} ``` ## Errors | Status | Code | When | | - | - | - | | `401` | | No key, or a key Orgo doesn’t know. | | `403` | `key_permission` | A restricted key without Workflows read. | | `404` | (no body) | Workflows aren’t open to your account. | | `429` | `rate_limited` | Too many streams open. Close one, then try again. Carries `Retry-After`. | | `503` | | Orgo couldn’t verify the key because of a server-side fault. Retry. | ## OpenAPI ````yaml GET /workflows/{id}/events 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}/events: get: tags: - Workflows summary: Follow a workflow’s changes and runs description: >- A text/event-stream: a data event with { lines, by, changed } when its steps change, `event: state` when it is turned on or off, renamed or its settings change, `event: run` with { run, by } as a run moves, and `event: deleted`. It closes after 5 minutes; open it again (EventSource does, after retry: 1000). At most 10 open at once per credential (429 rate_limited). parameters: - name: id in: path required: true schema: type: string pattern: ^[a-z0-9-]{1,60}$ example: morning-report responses: '200': description: The stream. content: text/event-stream: schema: type: string example: >+ retry: 1000 : open event: run data: {"run":{"run_id":"0d9c6c1e-5b8e-4a59-9d3b-7a1f2c3d4e5f","state":"running"},"by":"You"} '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: 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.