SHshipsecai
workflows

POST /api/v1/workflows/{id}/run

Changed on

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/api/v1/workflows/{id}/run
  • Auth
    none declared

Path parameters

idstring required

Request body

inputsobject
versionIdstring uuid
versioninteger

Response

Workflow execution result

runIdstring

Temporal workflow identifier

workflowIdstring

Workflow record id

temporalRunIdstring

Temporal first execution run id

taskQueuestring

Temporal task queue used for execution

workflowVersionIdstring

Workflow version identifier used for execution

workflowVersioninteger

Workflow version number used for execution

status'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'TERMINATED' | 'CONTINUED_AS_NEW' | 'TIMED_OUT' | 'UNKNOWN'

Changes