Automation
Workflows
Explore the data types and operations available in Workflows.
77 operations
Health check endpoint
productionSnapshotQueryRead production resources with batched evidence. Also requires workCenter:read; cell, operation, progress and job permissions are checked independently.
publishTemplateVersionMutationPublish current template content as a new version. Requires template:write permission.
queryProgressPointsQueryQuery progress tracking points with time range and dimensional filters, keyset-paginated in descending timestamp order. Requires progressPoint:list permission.
reconcileWorkflowExecutionRuntimeMutationRecord authenticated, audited evidence that the exact predecessor process has terminated before workflow recovery. Requires workflow:reconcileRuntime permission.
recordProgressPointsMutationRecord one or more progress tracking data points. Up to 10,000 points per request. Requires progressPoint:write permission.
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
renderTemplateMutationRender a template with context data. Requires template:execute permission.
resolveNodeOutputSchemaMutationResolve the best-effort JSON Schema for a node's output given its config — SwiftLua-inferred for script-backed kinds, falling back to the kind's static declared schema. Requires workflow:read permission.
restoreTemplateVersionMutationRestore template content from a previous version. Requires template:write permission.
resumeWorkflowExecutionMutationResume a workflow execution that is waiting for an external signal. Requires workflow:execute permission.
schemaAuthoringCatalogQueryCompiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
searchHelpQuerySearch human-facing manuals using shared semantic and text retrieval.
setActiveVersionMutationSet the active version of a workflow. Requires workflow:write permission.
topicExamplesQueryFetch examples by stable name, in requested order. Unknown names are errors; an empty list returns no examples.
updateTemplateMutationUpdate a template. Only provided fields are changed. Requires template:write permission.
updateWorkflowMutationUpdate an existing workflow. Requires workflow:write permission.
updateWorkflowTriggerMutationUpdate an existing workflow trigger
upsertTemplateMutationCreate or update a template. Requires template:write permission.
validateJinjaMutationStatically validate a workflow expression (parse + filter-name check) without evaluating it. Safe to call from editors on every keystroke.
validateTemplateMutationValidate template syntax without saving. Requires template:read permission.
validateWorkflowMutationValidate a workflow definition without importing it. Requires workflow:read permission.
workflowExecutionRuntimeManagementQueryInspect the exact workflow runner authority and audited recovery revision. Requires workflow:read permission.
workflowRunHealthQueryRun health of every workflow in the tenant that has a run since `since` or a run currently waiting: failures in the window, waiting runs and the latest run's status. Requires workflow:list permission.
workflowRunStatsQueryAggregate a workflow's runs over a time window: totals by status, duration percentiles, time buckets and per-node outcomes. Requires workflow:list permission.
workflowTriggerQueryGet a workflow trigger by ID. Requires workflow:read permission.
workflowTriggersQueryList all triggers for a workflow. Requires workflow:list permission.