Workflows

Execute Workflow

Changed on

Execute a workflow.

Path Parameters: - workflow_id: UUID of the workflow to execute

Request Body: - parameters: Optional execution parameters

Returns: Execution details (will be in 'running' status initially)

Note: This starts the execution and returns immediately. Use GET /workflows/{id}/executions/{execution_id} to check progress.

post/api/workflows/{workflow_id}/execute

Request

  • Base URL
    https://api.qomplement.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.qomplement.com/api/workflows/{workflow_id}/execute
  • Auth
    HTTP bearer

Path parameters

workflow_idstring required

Query parameters

organization_idstring nullable

Request body

parametersobject nullable

Response

Successful Response

idstring required
workflow_idstring required
user_idstring required
statusstring required
started_atstring required
completed_atstring nullable required
result_dataobject nullable required
error_messagestring nullable required
execution_logobject[] required
rows_processedinteger required
bytes_processedinteger required
execution_time_msinteger nullable required
metadata_jsonobject required
workflow_namestring nullable
workflow_snapshotobject nullable

Changes

    • info

      added the new optional query request parameter organization_id

    • info

      added the new optional request property

    • info

      the request property default value {} was removed