Workflows

Test the exact Workflow draft and return the receiptId required to create that unchanged version

Changed on

Executes the draft code once with exampleInput against the caller's live tools, validating the input against inputSchema and the result against outputSchema, and records a durable test receipt. The returned receiptId is the proof required by POST /v1/workflows/{configObjectId}/versions and is only accepted when every draft field is resubmitted unchanged within 15 minutes. Requires manager access to the Workflow; a script failure, argument mismatch, or result mismatch is returned as a 400 with the error code and message.

post/v1/workflows/test

Request

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

Request body

namestring required
descriptionstring
codestring required
exampleInputunknown
inputSchemaunknown
outputSchemaunknown
configObjectIdstring required

Response

Workflow draft tested.

receiptIdstring required
valueunknown required
markdownstring required
codeDigeststring required
resultDigeststring required
inputSchemaDigeststring nullable required
outputSchemaDigeststring nullable required
rendererVersion'codemode-markdown-v1' required
finishedAtstring date-time required

Changes

  • df3754993784Revision changes
    • info

      added the optional property to the response with the status

  • bb8ff73e4ad3Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security denApiKey was added to the API