Workflows

Run an exact Workflow version

Changed on

Executes the version identified by configObjectVersionId of this Workflow, under the Plugin named by pluginId, with input as the script's input, using the caller's live tools, and records a snapshot receipt. For a live app, pass mode: live and optional IANA timeZone (UTC default), omitting input: the server generates input.runtime (now, today, timeZone, dayStart, dayEnd) and enforces read-only capabilities, exactly like live authoring tests and renders. After receipt-backed saveWorkflow, run this saved version in live mode before save_artifact_view; authoring test receipts alone are not saved snapshots. The input is validated against the version's inputSchema and the result against its outputSchema; a mismatch is rejected with 400 invalid_capability_arguments, a required capability that is unavailable with capability_unavailable, and a thrown script error with script_failed. The caller needs a Workflow, Plugin, or Marketplace grant that covers this Workflow; an unknown Workflow or Plugin returns unknown_capability and a missing grant returns forbidden, both as 400.

post/v1/workflows/{configObjectId}/run

Request

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

Path parameters

configObjectIdstring required

Request body

pluginIdstring required
configObjectVersionIdstring required
inputunknown
mode'adhoc' | 'live'
timeZonestring

Response

Workflow executed.

status'succeeded' required
executionType'saved-workflow' required
mode'adhoc' | 'live' required
fetchedAtstring date-time required
timeZonestring
valueunknown required
markdownstring required
receiptIdstring nullable required
resultDigeststring required
inputSchemaDigeststring nullable required
outputSchemaDigeststring nullable required
rendererVersion'codemode-markdown-v1' required

Changes

    • info

      added the optional property to the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status