Workflows

Create an immutable Workflow version using the immediately preceding matching test receipt and unchanged draft

Changed on

Appends a new immutable version to the Workflow and updates its name and description. receiptId must reference a successful draft test by the caller that is less than 15 minutes old, has not already produced a version, and whose code, exampleInput, inputSchema, outputSchema, name, description, and requiredCapabilities all match this body byte-for-byte (400 workflow_matching_test_receipt_required). Every capability the test actually called must be listed in requiredCapabilities and still be available to the caller (400 workflow_capability_unavailable). Requires manager access to the Workflow.

post/v1/workflows/{configObjectId}/versions

Request

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

Path parameters

configObjectIdstring required

Request body

namestring required
descriptionstring
codestring required
exampleInputunknown
inputSchemaunknown
outputSchemaunknown
receiptIdstring required

Copy receiptId from the immediately preceding successful draft test. Submit the exact same name, description, code, exampleInput, inputSchema, outputSchema, and requiredCapabilities used by that test.

Response

Workflow version created.

pluginIdstring required
configObjectIdstring required
titlestring required
descriptionstring nullable required
canRunboolean required
canManageboolean required

Changes

    • info

      added the optional property to the response with the status

    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security denApiKey was added to the API