Execute Workflow Stream

POST
Executes a deployed Workflow and streams back its results.

Request

This endpoint expects an object.
inputs
list of unionsRequired
The list of inputs defined in the Workflow's Deployment with their corresponding values.
workflow_deployment_id
stringOptional

The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name.

workflow_deployment_name
stringOptional

The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.

release_tag
stringOptional
Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
external_id
stringOptional
Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
event_types
list of enumsOptional
Optionally specify which events you want to receive. Defaults to only WORKFLOW events. Note that the schema of non-WORKFLOW events is unstable and should be used with caution.
Allowed values: NODEWORKFLOW

Response

This endpoint returns a stream of union
Workflow
OR
Node
POST
1curl -X POST https://predict.vellum.ai/v1/execute-workflow-stream \
2     -H "X_API_KEY: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "inputs": [
6    {
7      "type": "STRING",
8      "name": "string",
9      "value": "string"
10    }
11  ]
12}'
Streamed Response
Built with