Skip to main content
POST
Check a workflow will work, sending 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

string
required
The workflow’s id, like morning-report.

Headers

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

boolean
true when every step will work.
array
Each step’s answer.
string[]
What to do, in plain words, one item per fix.

Example

Response

Stream

Errors

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Path Parameters

id
string
required
Pattern: ^[a-z0-9-]{1,60}$

Response

Each step’s answer (or the stream).

ok
boolean
required
steps
object[]
required
to_fix
string[]