TypeScript SDK

npm install valyu
# or
yarn add valyu

import { Valyu } from "valyu";

// The SDK will automatically use VALYU_API_KEY from environment
const valyu = new Valyu();

// Alternatively, you can still pass it explicitly
const valyu = new Valyu("your-api-key-here");

import { Valyu } from "valyu";

// Initialize the client
const valyu = new Valyu();

// Search for context about a specific topic
const response = await valyu.context({
    query: "What are the benefits of renewable energy?",
    searchType: "all",            // Search both proprietary and web sources
    maxNumResults: 5,             // Limit to top 5 results
    similarityThreshold: 0.5,     // Only return results with >50% relevance
    queryRewrite: true,           // Enable query optimization
    maxPrice: 10                  // Maximum price per thousand queries (CPM)
});

// Process the results
console.log(response);

{
    "success": true,
    "error": "",
    "tx_id": "tx_4cce8eed-7864-42ec-b385-dee7d5b14936",
    "query": "What are agentic search-enhanced large reasoning models?",
    "results": [
        {
            "title": "2501.05366",
            "url": "https://arxiv.org/abs/2501.05366",
            "content": "# Search-o1: Agentic Search-Enhanced Large Reasoning Models...",
            "source": "valyu/valyu-arxiv",
            "price": 0.0005,
            "length": 17442,
            "image_url": {
                "_page_1_Figure_0.jpeg": "https://..."
            },
            "dataType": "unstructured",
            "relevanceScore": 0.77734375
        }
        // Additional results...
    ],
    "resultsBySource": {
        "web": 1,
        "proprietary": 4
    },
    "totalDeductionPcm": 5.0,
    "totalDeductionDollars": 0.005,
    "totalCharacters": 81208
}