Execute Workflow

POST
Executes a deployed Workflow and returns its outputs.

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.

Response

This endpoint returns an object
execution_id
string
data
union
run_id
stringOptional
external_id
stringOptional
POST
1curl -X POST https://predict.vellum.ai/v1/execute-workflow \
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}'
200
Successful
1{
2  "execution_id": "string",
3  "data": {
4    "state": "FULFILLED",
5    "id": "string",
6    "outputs": [
7      {
8        "type": "STRING",
9        "id": "string",
10        "name": "string",
11        "value": "string"
12      }
13    ],
14    "ts": "2023-01-01T00:00:00Z"
15  },
16  "run_id": "string",
17  "external_id": "string"
18}
Built with