Skip to main content
Workflows are in Beta. Run a Valyu-curated workflow end to end in two minutes - no template authoring required.
A Workflow is a templated, versioned DeepResearch run. Pick a curated template, fill in its variables, and run it like any other deep research task.
1

Get your API key and install an SDK

Grab a key from the dashboard. New orgs start with free credits, so you can run immediately.
pip install valyu        # valyu-py >= 2.10.0
export VALYU_API_KEY="your-api-key"
2

List the Valyu workflows

Browse the 44 curated templates and grab a slug.
from valyu import Valyu

valyu = Valyu()  # reads VALYU_API_KEY
listing = valyu.workflows.list(scope="valyu")
for wf in listing.workflows:
    print(wf.slug, wf.title, wf.vertical)
3

Inspect a workflow's variables

Each workflow declares typed variables. Read them so you know exactly what workflow_params to send. The ib-company-profile workflow (“Company Profile”, investment-banking) takes one required variable, company.
profile = valyu.workflows.get("ib-company-profile")
print(profile.workflow.variables)
Look at the variables array - each entry has a key, type (text / textarea / number / date / enum), and a required flag.
4

Run it

Pass workflow_id and workflow_params to deepresearch.create. Do not also send a freeform query - the two are mutually exclusive.
task = valyu.deepresearch.create(
    workflow_id="ib-company-profile",
    workflow_params={"company": "NVIDIA (NVDA)"},
)
print(task.deepresearch_id)
print(task.workflow)  # { "slug": "ib-company-profile", "version": 1 }
5

Poll for completion and get the deliverable

The run is a normal DeepResearch task. Poll until it finishes, then read the report and fetch deliverables.
result = valyu.deepresearch.wait(task.deepresearch_id)
print(result.status)
print(result.output)
Want to confirm the resolved prompt before spending credits? Call valyu.workflows.preview(slug, workflow_params=...) (POST /v1/workflows/{slug}/preview) first - it resolves the template without running anything.

​
Next steps

Workflows guide

Variables, deliverables, versioning, scopes, and limits.

DeepResearch guide

The async research engine workflows run on.