Execute Workflow

POST
https://predict.vellum.ai/v1/execute-workflow
Executes a deployed Workflow and returns its outputs.

Request

This endpoint expects an object.
inputs
list of unions
The list of inputs defined in the Workflow's Deployment with their corresponding values.
workflow_deployment_id
optional string
The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name.
workflow_deployment_name
optional string
The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.
release_tag
optional string
Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
external_id
optional string
Optionally include a unique identifier for monitoring purposes. Must be unique for a given workflow deployment.

Response

This endpoint return an object.
execution_id
string
data
union
run_id
optional string
external_id
optional string
POST
/v1/execute-workflow
curl -X POST https://predict.vellum.ai/v1/execute-workflow \
-H "X_API_KEY: <apiKey>" \
-H "Content-Type: application/json" \
-d '{
"inputs": [
{
"type": "STRING",
"name": "string",
"value": "string"
}
]
}'
Response
{
"execution_id": "string",
"data": {
"state": "FULFILLED",
"id": "string",
"outputs": [
{
"type": "STRING",
"id": "string",
"name": "string",
"value": "string"
}
],
"ts": "2023-01-01T00:00:00Z"
},
"run_id": "string",
"external_id": "string"
}