UI-first Approach

Create a new folder for your project

$
mkdir my_workflow
>
cd my_workflow

Set up your environment

$
uv venv
>
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
>
uv add vellum-ai

Create a pyproject.toml file

1
[project]
2
name = "my_project"
3
version = "0.0.1"
4
5
[[tool.vellum.workflows]]
6
module = "my_workflow"
7
workflow_sandbox_id = "<we'll get this from the Vellum UI>"

Get a Sandbox ID from the Vellum UI

Go to a Workflow Sandbox in the Vellum UI and copy the ID from the URL. The ID is the last part of the URL:

For a URL like: https://app.vellum.ai/workflow-sandboxes/28fbaf9c-b89e-4534-87f7-abcdefghijkl

The workflow_sandbox_id is 28fbaf9c-b89e-4534-87f7-abcdefghijkl

Replace the workflow_sandbox_id in your pyproject.toml file with this ID.

Use the Vellum CLI to pull the Workflow

$
vellum workflows pull my_workflow --include-sandbox

Run it!

$
python -m my_workflow.sandbox