Workflows

Save a successful Code Mode run as a Workflow inside an OpenWork Connect Plugin

Changed on

Saves a successful authoring run as a reusable Workflow. Supply code or receiptId, or both with byte-identical source. Explicit receiptId requires a successful run from this caller in this organization within 15 minutes, retained source (encrypted shared storage when Redis is configured; process-local otherwise), and exactly matching tested input and schema digests; missing retention fails closed (400 workflow_authoring_receipt_required). Live receipts forbid currentInput, validate with their server-generated runtime, and never save runtime day bounds as example input. Without receiptId, the existing byte-exact recent successful code lookup applies (400 workflow_recent_receipt_required). Literal credentials in source are rejected, not sanitized. The run's tool calls become requiredCapabilities and must still be available. Saving creates no artifact snapshot linkage. Omit pluginId for the private My Workflows Plugin; a chosen Plugin requires editor access. Replacing a same-name Workflow requires manager access.

post/v1/workflows

Request

  • Base URL: https://api.openworklabs.com
  • URL: https://api.openworklabs.com/v1/workflows
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

pluginIdstring

Existing OpenWork Connect Plugin that will contain and share this Workflow. Omit to use the member's private My Workflows Plugin.

namestring required
descriptionstring
codestring

Exact tested source. Required without receiptId; if both are supplied it must byte-match the retained source.

receiptIdstring

Successful authoring receipt from this caller within 15 minutes. Encrypted source retention is shared across replicas when Redis is configured, otherwise process-local. If unavailable, retest or omit receiptId and supply the exact source.

currentInputunknown
inputSchemaunknown
outputSchemaunknown

Response

Workflow saved.

pluginIdstring required
configObjectIdstring required
configObjectVersionIdstring required
mermaidstring required

Changes