Skip to main content
GET
Get the pending synthesis confirmation
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/getSynthesisConfirmation Returns the newest unexpired synthesis batch in the draft’s active Architect conversation: each item the Architect proposes to build, with its spec and its cost and time estimates, and the Coherence Gate’s verdict on the batch. Nothing is written. The batch content belongs to the person who decides it, so this read needs workflows:write, the permission a deciding person holds. A person confirms all, some or none of it by completing the human task named by humanTaskId with completeHumanTask, or in the Forge Console.

Authentication

Personal key, External App credential or platform API key. Requires permission workflows:write, and workflows:write and workflows:read held at the workflow’s home org unit.

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 batch, or null when none is waiting.
The conversation’s session, the workspace, operator feedback and who resolved earlier batches 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 pending synthesis confirmation

data
object
required
meta
object
required