DeepResearch

from valyu import Valyu

valyu = Valyu()

# 1. Create a research task
task = valyu.deepresearch.create(
    query="What are the key differences between RAG and fine-tuning for LLMs?",
    mode="standard"
)

# 2. Wait for completion (polls until done, fails, or is cancelled)
result = valyu.deepresearch.wait(task.deepresearch_id)

# 3. Read the result
if result.status == "completed":
    print(result.output)
    for source in result.sources:
        print(f"- {source.title}: {source.url}")
    print(f"Cost: ${result.cost}")

import { Valyu } from "valyu-js";

const valyu = new Valyu();

// 1. Create a research task
const task = await valyu.deepresearch.create({
  query: "What are the key differences between RAG and fine-tuning for LLMs?",
  mode: "standard"
});

// 2. Wait for completion (polls until done, fails, or is cancelled)
const result = await valyu.deepresearch.wait(task.deepresearch_id);

// 3. Read the result
if (result.status === "completed") {
  console.log(result.output);
  result.sources?.forEach(s => console.log(`- ${s.title}: ${s.url}`));
  console.log(`Cost: $${result.cost}`);
}

# Create a task, then poll GET /v1/deepresearch/tasks/{id}/status until completed
curl -X POST "https://api.valyu.ai/v1/deepresearch/tasks" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "query": "What are the key differences between RAG and fine-tuning for LLMs?",
    "mode": "standard"
  }'

# Markdown + PDF
task = valyu.deepresearch.create(
    query="Write a report on renewable energy trends",
    output_formats=["markdown", "pdf"]
)
result = valyu.deepresearch.wait(task.deepresearch_id)
print(result.pdf_url)  # downloadable PDF

// Markdown + PDF
const task = await valyu.deepresearch.create({
  query: "Write a report on renewable energy trends",
  outputFormats: ["markdown", "pdf"]
});
const result = await valyu.deepresearch.wait(task.deepresearch_id);
console.log(result.pdf_url); // downloadable PDF

task = valyu.deepresearch.create(
    query="Impact of GLP-1 receptor agonists on cardiovascular outcomes",
    mode="standard",
    research_strategy="Focus on Phase 3 clinical trials published after 2022. "
                      "Compare semaglutide, tirzepatide, and liraglutide.",
    report_format="Write a 2-page executive summary: 1) Key Findings (bullets), "
                  "2) Comparison Table, 3) Clinical Implications. Formal medical style.",
)

const task = await valyu.deepresearch.create({
  query: "Impact of GLP-1 receptor agonists on cardiovascular outcomes",
  mode: "standard",
  researchStrategy: "Focus on Phase 3 clinical trials published after 2022. " +
                    "Compare semaglutide, tirzepatide, and liraglutide.",
  reportFormat: "Write a 2-page executive summary: 1) Key Findings (bullets), " +
                "2) Comparison Table, 3) Clinical Implications. Formal medical style.",
});

task = valyu.deepresearch.create(
    query="Latest AI research",
    search={
        "included_sources": ["academic", "web"],
        "start_date": "2024-01-01",
        "country_code": "US"
    }
)

const task = await valyu.deepresearch.create({
  query: "Latest AI research",
  search: {
    includedSources: ["academic", "web"],
    startDate: "2024-01-01",
    countryCode: "US"
  }
});

task = valyu.deepresearch.create(
    query="Analyse Tesla's Q3 2026 earnings with revenue charts",
    mode="heavy",
    tools={
        "code_execution": { "enabled": True },
        "screenshots": { "enabled": True, "max_calls": 5 },
        "browser_use": { "enabled": True, "max_calls": 2 },
        "charts": True,
    }
)

const task = await valyu.deepresearch.create({
  query: "Analyse Tesla's Q3 2026 earnings with revenue charts",
  mode: "heavy",
  tools: {
    code_execution: { enabled: true },
    screenshots: { enabled: true, max_calls: 5 },
    browser_use: { enabled: true, max_calls: 2 },
    charts: true,
  },
});

import base64

with open("report.pdf", "rb") as f:
    pdf_data = base64.b64encode(f.read()).decode()

task = valyu.deepresearch.create(
    query="Summarize the key findings and compare with current market trends",
    mode="heavy",
    files=[{
        "data": f"data:application/pdf;base64,{pdf_data}",
        "filename": "report.pdf",
        "mediaType": "application/pdf",
        "context": "Q4 2024 financial report"
    }],
    urls=["https://example.com/article-1", "https://example.com/article-2"]
)

import * as fs from "fs";

const pdfData = fs.readFileSync("report.pdf").toString("base64");

const task = await valyu.deepresearch.create({
  query: "Summarize the key findings and compare with current market trends",
  mode: "heavy",
  files: [{
    data: `data:application/pdf;base64,${pdfData}`,
    filename: "report.pdf",
    mediaType: "application/pdf",
    context: "Q4 2024 financial report"
  }],
  urls: ["https://example.com/article-1", "https://example.com/article-2"]
});

# Check status
status = valyu.deepresearch.status(task_id)
print(status.status)

# Add a follow-up instruction (only before the writing phase starts)
valyu.deepresearch.update(task_id, instruction="Focus more on peer-reviewed sources")

# Cancel, delete, list
valyu.deepresearch.cancel(task_id)
valyu.deepresearch.delete(task_id)
tasks = valyu.deepresearch.list(limit=50)

// Check status
const status = await valyu.deepresearch.status(taskId);
console.log(status.status);

// Add a follow-up instruction (only before the writing phase starts)
await valyu.deepresearch.update(taskId, "Focus more on peer-reviewed sources");

// Cancel, delete, list
await valyu.deepresearch.cancel(taskId);
await valyu.deepresearch.delete(taskId);
const tasks = await valyu.deepresearch.list({ limit: 50 });

task = valyu.deepresearch.create(
    query="Research market trends",
    webhook_url="https://your-app.com/webhooks/deepresearch"
)

# Save the secret immediately - it's only returned once
webhook_secret = task.webhook_secret

const task = await valyu.deepresearch.create({
  query: "Research market trends",
  webhookUrl: "https://your-app.com/webhooks/deepresearch"
});

// Save the secret immediately - it's only returned once
const webhookSecret = task.webhook_secret;