POST
/
workflows
/
{workflow_id}
/
invoke
curl --location 'https://api.mixpeek.com/workflows/unique_workflow_id/invoke' \
--header 'Authorization: Bearer API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "parameters": {
        "file_url": "https://example.com/data.csv",
        "analysis_type": "comprehensive"
    },
    "websocket_id": "ws_connection_id"
}'

{
  "execution_id": "<string>",
  "status": "<string>"
}

​
Request

workflow_id
string
required

The unique identifier of the workflow to be invoked. This ID specifies the particular workflow to execute, ensuring the correct logic and operations are applied to the data.

websocket_id
string

An optional Websocket ID for real-time updates on the workflow’s execution status. If provided, it enables the streaming of logs, results, and other notifications directly to a specified websocket connection.

parameters
object

Custom parameters to be passed to the workflow at runtime. These parameters can include any data the workflow needs to execute its logic, such as input file URLs, configuration settings, or contextual information.

​
Response

execution_id
string
required

A unique identifier for the instance of the workflow invocation. This ID can be used to track the execution status, retrieve results, and manage the workflow’s output.

status
string
required

Provides immediate feedback on the workflow invocation, indicating whether the execution has started successfully or if any issues were encountered during the initiation process.

Create WorkflowInsert Object