Skip to main content
GET
Get a workflow draft's Workflow Architect status
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/getArchitectStatus Reports whether the workflow’s editable draft has a live Workflow Architect conversation and whether a plan card or a synthesis batch is waiting on a person. When a decision is pending, handoff gives the Forge Console page where a person makes it. Nothing is written. A Personal key starts and continues a conversation with startArchitectConversation and sendArchitectMessage. Plans and synthesis batches are decided by a person: through their human task with POST /api/v2/governance/completeHumanTask, or in the Forge Console at the handoff link.

Authentication

External App credential or platform API key. Requires permission workflows:read, held at the workflow’s home org unit. The org unit a request acts from is not the workflow’s home.

Query parameters

string
required
The workflow ID. Give it exactly once.

Responses

string
The workflow ID.
string
The draft’s ID.
string
open (the draft has an active Architect conversation; a turn may or may not be running), stopping (a cancelled turn is winding down) or none. Pending decisions are reported only while open, when the Console shows them; while stopping, read again after the turn ends.
object | null
The newest unexpired plan card waiting on a person: proposalId, createdAt and expiresAt (epoch milliseconds). null when none.
object | null
The newest unexpired synthesis batch waiting on a person: confirmationId, createdAt, expiresAt and itemCount. null when none.
boolean
true when a plan card or a synthesis batch is waiting on a person.
object | null
Present exactly when awaitingPerson is true. kind is console and decidedBy is person; item is workflow_architect:<draftId>; path is the Console workflow builder with the Architect open; url is the absolute link, or null when the deployment does not name its Console; requiredPermission is workflows:write, the permission the deciding person holds.
The plan text, the conversation, the synthesis items and their costs, and who started or answered anything are not returned. Open handoff.url in the Forge Console to see them.

Errors

Example

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

Workflow document id. Give it exactly once.

Minimum string length: 1

Response

The draft's Architect status.

data
object
required

Whether a workflow's draft has a live Workflow Architect conversation and whether a plan card or a synthesis batch waits on a person. No plan text, conversation content, synthesis item, cost or person id is returned. Architect messages are sent with sendWorkflowArchitectMessage. A person confirms or rejects a plan or batch by completing its human task with completeHumanTask (Personal key), or in the Console at handoff.

meta
object
required