Skip to main content
POST
Python

Authorizations

Authorization
string
header
required

Enter your JWT token

Body

application/json

The plan, as JSON.

POST /v1/workflows's body: the plan, and optionally a folder of the caller's scope to file it in.

plan
object | null

The plan an AI agent writes; the compiler turns it into a real workflow.

folderId
integer<int32> | null

Response

Created.

workflowId
integer<int32>
required
revisionId
integer<int64>
required

The new workflow's revision: what a following update sends as expectedRevisionId.

diagnostics
object[]
required

The plan's warnings (a write never carries an error).

workspaceId
string<uuid>
required

The workspace the row was stamped with.

environmentId
string<uuid>
required

The environment the row was stamped with.

designerUrl
string | null

Where a person opens it: the app's designer page, from EnginiServices_ClientUI. Null (explicitly nullable) when that address is not configured on this deployment; the workflow is still created.

webhookUrl
string | null

The address an external system sends to in order to start the workflow, when its trigger is a webhook Engini hands out (WorkflowWebhookUrlResolver); null for every other trigger. The token in it authorizes calls, so it is a credential.