API ReferenceWorkflows
Validate or preview unsaved executable workflow content without writing or running it.
Omit operation for the existing compilation response. Set operation to preview to receive compiler findings, scoped graph and pane schema metadata, and a bounded SVG schematic. A schematic is not a screenshot of bespoke panels or an execution receipt.
POST
header
AuthorizationBearer <rsk_live_*>Rensei API key presented as Authorization: Bearer rsk_live_. Required API-key scopes are recorded per operation in x-rensei-required-scopes.
application/json- body
projectId*stringLength
1 <= lengthformat*stringcanvas*unknownCompilation diagnostics and explicit checked/skipped phases. Valid is limited to the checked phases and does not grant publish or execution readiness.
application/json- response
valid*booleancatalogRevision?stringdefinitionVersion?stringValue in
"2""1.1"diagnostics*array<>phases*array<>curl -X POST 'https://app.rensei.ai/api/cli/workflows/compile' \ -H 'Content-Type: application/json' \ -d '{ "projectId": "string", "format": "canvas", "canvas": null}'Example Response
{ "valid": true, "catalogRevision": "string", "definitionVersion": "2", "diagnostics": [ { "code": "string", "severity": "error", "phase": "string", "path": "string", "message": "string", "remediation": "string", "line": 1, "column": 1 } ], "phases": [ { "phase": "string", "status": "checked", "reason": "string" } ]}