Workflows

Preview a workflow without effects or explicitly start a live run

post/workflows/{id}/runs

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/workflows/{id}/runs
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Path parameters

idstring required

Query parameters

workspace_idstring required

Request body

$schemastring uri

A URL to the JSON Schema for this object.

expected_revisioninteger required
mode'preview' | 'live' required
sourceobject required

Example request

{
  "$schema": "https://example.com/api/v1/schemas/WorkflowStartInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring date-time required
current_step_idstring
errorstring
idstring required
modestring required
revisioninteger required
sourceobject required
statestring required
updated_atstring date-time required
wake_atstring date-time
workflow_idstring required
workflow_namestring required
workflow_revisioninteger required
workspace_idstring required

Example response

{
  "$schema": "https://example.com/api/v1/schemas/WorkflowRun.json",
  "definition": {
    "source": {
      "$schema": "https://example.com/api/v1/schemas/WorkflowSource.json"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.