Skip to main content
GET
Get a workflow's node capability 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/getCapabilityReadiness?draftOf=<workflowId> or ?versionId=<versionId> reads each produce node of a workflow’s draft (draftOf) or of one published version (versionId), and whether its agent holds the skills, tool sets and external tools the node needs.

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.

Query and response

Name exactly one of draftOf and versionId, once; otherwise 400. Each entry has nodeId and status: {kind: "ok"}, {kind: "no_requirements"}, or {kind: "gap", missing}, where each missing capability has kind (skill, toolSet or externalTool), id and reason (structural or declared). At most 200 nodes are read; meta.partial is true when the graph has more.

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.

Query Parameters

draftOf
string

The workflow whose draft is read.

Minimum string length: 1
versionId
string

A published version to read instead.

Minimum string length: 1

Response

Success

data
object[]
required
meta
object
required