Execute Workflow

Executes a deployed Workflow and returns its outputs.

Request

This endpoint expects an object.

inputslist of objectsRequired

The list of inputs defined in the Workflow's Deployment with their corresponding values.

expand_metaobject or nullOptional

An optionally specified configuration used to opt in to including additional metadata about this workflow execution in the API response. Corresponding values will be returned under the execution_meta key within NODE events in the response stream.

workflow_deployment_idstring or nullOptionalformat: "uuid"

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

workflow_deployment_namestring or nullOptional>=1 character

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

release_tagstring or nullOptional>=1 character

Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment

external_idstring or nullOptional>=1 character

Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace.

metadatamap from strings to any or nullOptional

Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis.

Response

execution_idstring

dataobject

external_idstring or null

run_idstring or nullDeprecated

1	import { VellumClient } from "vellum-ai";
2
3	const client = new VellumClient({ apiKey: "YOUR_API_KEY" });
4	await client.executeWorkflow({
5	inputs: [{
6	name: "name",
7	type: "STRING",
8	value: "value"
9	}]
10	});

1	{
2	"execution_id": "foo",
3	"data": {
4	"id": "foo",
5	"state": "FULFILLED",
6	"ts": "foo",
7	"outputs": [
8	{
9	"id": "foo",
10	"name": "foo",
11	"type": "STRING",
12	"value": "foo"
13	}
14	]
15	},
16	"external_id": "foo",
17	"run_id": "foo"
18	}

Headers

Request

Response

Errors