Skip to main content
POST
Set the Architect's JIT synthesis mode
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

POST /api/v2/workflows/setArchitectJitMode The API twin of the Architect drawer’s JIT toggle. With JIT synthesis on, the Architect may propose building primitives the catalog lacks; each build still waits on a person’s synthesis confirmation. Read the mode with getArchitectJitMode.

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. The caller must also be the draft’s author (a Personal key’s owner, or the app or key that created the draft) or hold platform:manage at the platform scope, as in the Console.

Headers

string
Optional. A same-key retry within 24 hours returns the recorded answer without writing again, only while the caller may still write the draft of the workflow that answer names, at that workflow’s home; otherwise 409 idempotency_result_unavailable. The same key with a different body is 422. See Idempotency.

Body

string
required
The workflow ID.
string
required
on or off.

Responses

200 with data.workflowId, data.draftId and data.channelMode, the mode now set.

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.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

workflowId
string
required

The workflow id.

Minimum string length: 1

Body

application/json
mode
enum<string>
required

on lets the Architect synthesize missing primitives; off stops it.

Available options:
off,
on

Response

Set the Architect's JIT synthesis mode

data
object
required
meta
object
required