Workflows Quickstart

pip install valyu        # valyu-py >= 2.10.0
export VALYU_API_KEY="your-api-key"

npm install valyu-js      # valyu-js >= 2.8.0
export VALYU_API_KEY="your-api-key"

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)

import { Valyu } from "valyu-js";

const valyu = new Valyu(process.env.VALYU_API_KEY!);
const listing = await valyu.workflows.list({ scope: "valyu" });
listing.workflows.forEach((wf) => console.log(wf.slug, wf.title, wf.vertical));

curl "https://api.valyu.ai/v1/workflows?scope=valyu" \
  -H "x-api-key: $VALYU_API_KEY"

profile = valyu.workflows.get("ib-company-profile")
print(profile.workflow.variables)

const profile = await valyu.workflows.get("ib-company-profile");
console.log(profile.workflow.variables);

curl "https://api.valyu.ai/v1/workflows/ib-company-profile" \
  -H "x-api-key: $VALYU_API_KEY"

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 }

const task = await valyu.deepresearch.create({
  workflowId: "ib-company-profile",
  workflowParams: { company: "NVIDIA (NVDA)" },
});
console.log(task.deepresearch_id);
console.log(task.workflow); // { slug: "ib-company-profile", version: 1 }

curl -X POST "https://api.valyu.ai/v1/deepresearch/tasks" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $VALYU_API_KEY" \
  -d '{
    "workflow_id": "ib-company-profile",
    "workflow_params": { "company": "NVIDIA (NVDA)" }
  }'

result = valyu.deepresearch.wait(task.deepresearch_id)
print(result.status)
print(result.output)

const result = await valyu.deepresearch.wait(task.deepresearch_id);
console.log(result.status);
console.log(result.output);

curl "https://api.valyu.ai/v1/deepresearch/tasks/{task_id}/status" \
  -H "x-api-key: $VALYU_API_KEY"