Skip to main content
GET
Get a workflow's agent readiness
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/workflows/getAgentReadiness?id=<workflowId>[&versionId=<versionId>] reads agent readiness per Run-as-Agent produce node of the workflow’s active version, or of versionId: whether each node’s agent can be dispatched, check by check.

Authentication

External App credential or platform API key, or a Personal key. Requires permission workflows:read at the workflow’s home: a workflow that is malformed, unknown, trashed, unhomed or outside the caller’s reach answers 404. A Personal key acts as its owner, narrowed by its scopes.

Response

Each entry has nodeId, agentDefinitionId, optionally agentName, and report. A node’s report is given only for an agent the caller may read (agents:read granted at its home and reached by the credential’s scopes; otherwise the report is null and no name is given); a PERSONAL agent’s report is never given (null). A report has the agent’s status (ready, attention or blocked), its checks (each with id, outcome, blocksDispatch, gate, code, message and action) and its autonomy. A failing check’s fix is named by its kind only (action.kind). A version that is not this workflow’s answers 404; a workflow with no active version answers an empty list.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

workflowId
string
required

The workflow.

Minimum string length: 1

Query Parameters

versionId
string

A published version to read instead of the active one.

Minimum string length: 1

Response

Success

data
object[]
required
meta
object
required