Skip to main content
GET
Get the Architect's pending plan
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/getArchitectPlan Returns the newest unexpired plan the Workflow Architect proposed in the draft’s active conversation: its topology, the decisions it inferred, its open questions and its steps. Nothing is written. A person confirms, edits or rejects the plan by completing the human task named by humanTaskId with completeHumanTask, or in the Forge Console at getArchitectStatus’s handoff link.

Authentication

Personal key, 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.
object | null
The pending plan, or null when none is waiting (or the draft has no active Architect conversation).
The conversation’s session, its transcript and who resolved earlier plans are not returned.

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

Get the Architect's pending plan

data
object
required
meta
object
required