Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Workflows API

Create a Workflow from Template

Use this endpoint to create a new workflow from a catalog template. The template parameters are validated against the template's JSON Schema. The new workflow is created in draft status.

post/v1/workflows/from-template

Request body

templateIdstring required

Identifier of the catalog template to use.

paramsobject required

Template parameter values used to generate the workflow.

Example request

{
  "templateId": "payment-validation",
  "params": {
    "executorId": "a1b2c3d4-e5f6-4789-a012-345678901234",
    "currency": "USD"
  }
}

Response

Indicates that the resource was successfully created and the operation was completed as expected.

createdAtstring date-time

Timestamp when the workflow was created.

statusstring

Initial status of the workflow (always draft on creation).

versionstring

Version of the workflow definition.

workflowIdstring uuid

Unique identifier of the created workflow.

Example response

{
  "createdAt": "2026-03-17T14:30:00Z",
  "status": "draft",
  "version": "1.0.0",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}