QUquivaworks
Workflows

Run a workflow

Changed on

Executes a workflow with the specified trigger data

Resuming a run that is not paused or errored answers 409; it does not start the flow again. The paused entry is claimed when the resume is accepted, so a second submit is refused. A call with await: false can now return an error, including start-up failures, and waits for the first stream write.

post/hub/workflows/{collection_topic}/{flow_topic}/run

Request

Request body

subjectstring required

Workflow subject. Published: ms.hub.config.workflow.{collection}.{flow} (NO 'published' segment - get it from listWorkflows version=published). Draft: ms.hub.config.workflow.draft.{collection}.{flow}.

triggerobject

Run input, referenced in nodes via $.trigger

triggersobject[]

Batch execution (use either trigger or triggers)

awaitboolean

true = wait for completion and return results; false = return tracking_id immediately

enable_logboolean

Store detailed run logs (searchable via searchRunLogs)

knowledgestring[]

Knowledge URIs for agents: kv://, obj://, str://, sid://, dta://

session_idstring

Agent conversation continuity; omit for new sessions

run_idstring

Full tracking id of a paused or errored run to resume (human-in-the-loop), in the form ms.hub.run.<uuid>.<flow subject>, as returned when the run started and by the paused-runs list. A bare uuid is rejected with 400 invalid run_id. Resuming a run that is not paused or errored returns 409.

retryboolean

Retry a failed run

Response

Workflow executed successfully

OR
string required

Status message for debounced or ordered executions

Changes

  • 8730377687f9Revision changes
    • breaking

      added the new required request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property default value changed from false to true

    • info

      added the non-success response with the status

  • 945cf8329cbeRevision changes
    • warning

      removed the request property

    • info

      added the new optional query request parameter draft to all path's operations