# Table of Contents - [Valyu Documentation](#valyu-documentation) - [API Migrations | Valyu](#api-migrations-valyu) - [Valyu Documentation](#valyu-documentation) - [List Datasource Categories | Valyu](#list-datasource-categories-valyu) - [Contents | Valyu](#contents-valyu) - [Answer | Valyu](#answer-valyu) - [List Datasources | Valyu](#list-datasources-valyu) - [DeepResearch - Cancel Batch | Valyu](#deepresearch-cancel-batch-valyu) - [DeepResearch - List Batches | Valyu](#deepresearch-list-batches-valyu) - [DeepResearch - Add Tasks to Batch | Valyu](#deepresearch-add-tasks-to-batch-valyu) - [DeepResearch - Get Batch Status | Valyu](#deepresearch-get-batch-status-valyu) - [DeepResearch - Cancel Task | Valyu](#deepresearch-cancel-task-valyu) - [DeepResearch - List Batch Tasks | Valyu](#deepresearch-list-batch-tasks-valyu) - [DeepResearch - List Tasks | Valyu](#deepresearch-list-tasks-valyu) - [DeepResearch - Create Batch | Valyu](#deepresearch-create-batch-valyu) - [DeepResearch - Delete Task | Valyu](#deepresearch-delete-task-valyu) - [DeepResearch - Get Status | Valyu](#deepresearch-get-status-valyu) - [DeepResearch - Create Task | Valyu](#deepresearch-create-task-valyu) - [DeepResearch - Update Task | Valyu](#deepresearch-update-task-valyu) - [Python Quickstart | Valyu](#python-quickstart-valyu) - [Design Assets | Valyu](#design-assets-valyu) - [Build with Valyu | Valyu](#build-with-valyu-valyu) - [LM Studio Plugin | Valyu](#lm-studio-plugin-valyu) - [Search | Valyu](#search-valyu) - [Rust Quickstart | Valyu](#rust-quickstart-valyu) - [TypeScript Quickstart | Valyu](#typescript-quickstart-valyu) - [Data Coverage | Valyu](#data-coverage-valyu) - [Local MCP | Valyu](#local-mcp-valyu) - [n8n Integration | Valyu](#n8n-integration-valyu) - [Page Not Found](#page-not-found) - [Page Not Found](#page-not-found) - [Page Not Found](#page-not-found) - [Page Not Found](#page-not-found) - [Page Not Found](#page-not-found) - [Page Not Found](#page-not-found) - [Page Not Found](#page-not-found) - [Page Not Found](#page-not-found) --- # Valyu Documentation [Skip to main content](https://docs.valyu.ai/AGENTS#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) On this page * [Repository Guidelines](https://docs.valyu.ai/AGENTS#repository-guidelines) * [Project Structure & Module Organization](https://docs.valyu.ai/AGENTS#project-structure-%26-module-organization) * [Build, Test, and Development Commands](https://docs.valyu.ai/AGENTS#build%2C-test%2C-and-development-commands) * [Coding Style & Naming Conventions](https://docs.valyu.ai/AGENTS#coding-style-%26-naming-conventions) * [Testing Guidelines](https://docs.valyu.ai/AGENTS#testing-guidelines) * [Commit & Pull Request Guidelines](https://docs.valyu.ai/AGENTS#commit-%26-pull-request-guidelines) * [Configuration & Access Tips](https://docs.valyu.ai/AGENTS#configuration-%26-access-tips) [​](https://docs.valyu.ai/AGENTS#repository-guidelines) Repository Guidelines ================================================================================ [​](https://docs.valyu.ai/AGENTS#project-structure-&-module-organization) Project Structure & Module Organization -------------------------------------------------------------------------------------------------------------------- * Root `.mdx` files (e.g., `overview.mdx`, `quickstart.mdx`) power the top-level navigation defined in `docs.json`. * Topical directories such as `api-reference/endpoint`, `integrations/`, `sdk/`, and `search/` hold focused guides; keep related assets in `images/` or `logo/`. * Shared API contracts live in `api-reference/openapi.json`; update this before revising endpoint docs. [​](https://docs.valyu.ai/AGENTS#build,-test,-and-development-commands) Build, Test, and Development Commands ---------------------------------------------------------------------------------------------------------------- * `npm i -g mintlify` installs the Mintlify CLI required for local preview. * `mintlify dev` (run from the repository root) launches the hot-reloading docs server. * `mintlify build` validates the content and produces the static site bundle that matches production. * `mintlify install` repairs CLI dependencies if the dev server fails to start. [​](https://docs.valyu.ai/AGENTS#coding-style-&-naming-conventions) Coding Style & Naming Conventions -------------------------------------------------------------------------------------------------------- * Author pages in MDX with frontmatter containing `title` and `description`; place the metadata between triple-dashed lines. * Use sentence case headings starting at `##`; reserve `#` for the page title handled by frontmatter. * Prefer `kebab-case` filenames and directory names that mirror sidebar labels. * Leverage Mintlify components (``, ``, ``) and keep JSX props indented two spaces for readability. [​](https://docs.valyu.ai/AGENTS#testing-guidelines) Testing Guidelines -------------------------------------------------------------------------- * Preview all edits with `mintlify dev` and scan for console warnings, broken components, and layout regressions. * Manually click through new or changed sidebar entries to ensure anchors render and links resolve. * Run `mintlify build` before submitting substantial changes to catch syntax or MDX compilation errors. * There is no automated coverage requirement; rely on peer review and screenshots for complex UI updates. [​](https://docs.valyu.ai/AGENTS#commit-&-pull-request-guidelines) Commit & Pull Request Guidelines ------------------------------------------------------------------------------------------------------ * Follow the existing convention of `[TYPE] Short description` (e.g., `[FEAT] Add DeepSearch example`); use `[CHORE]`, `[FIX]`, and `[DOCS]` as needed. * Keep commits scoped to a single thematic change and include relevant documentation assets. * Pull requests should describe the change, reference any tracked issue, list verification steps (`mintlify dev`, `mintlify build`), and attach screenshots or GIFs when visual output changes. [​](https://docs.valyu.ai/AGENTS#configuration-&-access-tips) Configuration & Access Tips -------------------------------------------------------------------------------------------- * Update theme, navigation groups, and footer links in `docs.json`; propose structured diffs when altering shared config. * Never commit real API keys; use placeholders in samples and sanitize environment variables before sharing logs. * Store newly created images under `images/` with descriptive filenames, and compress assets to keep the docs lightweight. Was this page helpful? YesNo ⌘I --- # API Migrations | Valyu [Skip to main content](https://docs.valyu.ai/api-migration#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Important Updates API Migrations [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) On this page * [Search Endpoint Migration](https://docs.valyu.ai/api-migration#search-endpoint-migration) * [What’s Changing](https://docs.valyu.ai/api-migration#what%E2%80%99s-changing) * [Timeline](https://docs.valyu.ai/api-migration#timeline) * [How to Update](https://docs.valyu.ai/api-migration#how-to-update) * [SDK Updates](https://docs.valyu.ai/api-migration#sdk-updates) * [API Domain Change](https://docs.valyu.ai/api-migration#api-domain-change) * [What This Means](https://docs.valyu.ai/api-migration#what-this-means) * [Timeline](https://docs.valyu.ai/api-migration#timeline-2) * [How to Update](https://docs.valyu.ai/api-migration#how-to-update-2) * [SDK Updates](https://docs.valyu.ai/api-migration#sdk-updates-2) * [Questions?](https://docs.valyu.ai/api-migration#questions) [​](https://docs.valyu.ai/api-migration#search-endpoint-migration) Search Endpoint Migration ----------------------------------------------------------------------------------------------- **Action Required** — The `/v1/deepsearch` endpoint is being renamed to `/v1/search`. The old endpoint will be deprecated on **April 30th, 2025**. We are migrating our search endpoint from `/v1/deepsearch` to `/v1/search` to better reflect its capabilities and simplify our API surface. ### [​](https://docs.valyu.ai/api-migration#what%E2%80%99s-changing) What’s Changing | Current Endpoint | New Endpoint | Deprecation Date | | --- | --- | --- | | `POST /v1/deepsearch` | `POST /v1/search` | April 30th, 2025 | ### [​](https://docs.valyu.ai/api-migration#timeline) Timeline * **Now**: Both `/v1/deepsearch` and `/v1/search` are fully operational and identical * **Until April 30th, 2025**: Both endpoints function identically * **After April 30th, 2025**: The `/v1/deepsearch` endpoint will be removed ### [​](https://docs.valyu.ai/api-migration#how-to-update) How to Update Simply replace `deepsearch` with `search` in your API calls: **Before:** Copy curl -X POST https://api.valyu.ai/v1/deepsearch \ -H "x-api-key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"query": "your search query"}' **After:** Copy curl -X POST https://api.valyu.ai/v1/search \ -H "x-api-key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"query": "your search query"}' ### [​](https://docs.valyu.ai/api-migration#sdk-updates) SDK Updates Our official SDKs handle this automatically. Ensure you’re using the latest versions: * **Python SDK**: `pip install --upgrade valyu` * **TypeScript SDK**: `npm update valyu-js` * **Rust SDK**: `cargo update -p valyu` The request and response formats remain unchanged. This is purely an endpoint rename. * * * [​](https://docs.valyu.ai/api-migration#api-domain-change) API Domain Change ------------------------------------------------------------------------------- We have migrated our API endpoint from `api.valyu.network` to `api.valyu.ai`. ### [​](https://docs.valyu.ai/api-migration#what-this-means) What This Means * **New API endpoint**: All API requests should now be directed to `https://api.valyu.ai` * **Backward compatibility**: The old endpoint `https://api.valyu.network` will continue to work and remain identical to `api.valyu.ai` until **January 1st, 2026** * **Action required**: Please update your integrations to use the new domain at your earliest convenience ### [​](https://docs.valyu.ai/api-migration#timeline-2) Timeline * **Now**: `api.valyu.ai` is fully operational * **Until January 1st, 2026**: Both `api.valyu.network` and `api.valyu.ai` will function identically * **After January 1st, 2026**: The `api.valyu.network` endpoint will be deprecated ### [​](https://docs.valyu.ai/api-migration#how-to-update-2) How to Update Simply replace `api.valyu.network` with `api.valyu.ai` in your API calls: **Before:** Copy curl -X POST https://api.valyu.network/v1/search \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"query": "your search query"}' **After:** Copy curl -X POST https://api.valyu.ai/v1/search \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"query": "your search query"}' ### [​](https://docs.valyu.ai/api-migration#sdk-updates-2) SDK Updates If you’re using our official SDKs, make sure you’re using the latest version which already points to `api.valyu.ai`: * [Python SDK](https://docs.valyu.ai/sdk/python-sdk) * [TypeScript SDK](https://docs.valyu.ai/sdk/typescript-sdk) ### [​](https://docs.valyu.ai/api-migration#questions) Questions? If you have any questions or concerns about these migrations, please contact us at [\[email protected\]](https://docs.valyu.ai/cdn-cgi/l/email-protection#85e6eaebf1e4e6f1c5f3e4e9fcf0abe4ec) or join our [Discord community](https://discord.gg/umtmSsppRY) . Was this page helpful? YesNo [Data Coverage](https://docs.valyu.ai/concepts/data-coverage) [Pricing](https://docs.valyu.ai/pricing) ⌘I --- # Valyu Documentation [Skip to main content](https://docs.valyu.ai/changelog/platform#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Platform Changelog [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) On this page * [January 09, 2026](https://docs.valyu.ai/changelog/platform#january-09%2C-2026) * [January 02, 2026](https://docs.valyu.ai/changelog/platform#january-02%2C-2026) * [December 26, 2025](https://docs.valyu.ai/changelog/platform#december-26%2C-2025) * [December 19, 2025](https://docs.valyu.ai/changelog/platform#december-19%2C-2025) * [December 12, 2025](https://docs.valyu.ai/changelog/platform#december-12%2C-2025) * [December 5, 2025](https://docs.valyu.ai/changelog/platform#december-5%2C-2025) * [November 28, 2025](https://docs.valyu.ai/changelog/platform#november-28%2C-2025) * [November 21, 2025](https://docs.valyu.ai/changelog/platform#november-21%2C-2025) * [November 14, 2025](https://docs.valyu.ai/changelog/platform#november-14%2C-2025) * [November 7, 2025](https://docs.valyu.ai/changelog/platform#november-7%2C-2025) [​](https://docs.valyu.ai/changelog/platform#january-09%2C-2026) January 09, 2026 * **Community referrals:** Invite others to Valyu and earn shared credits through the new referral program. * **Batch operations guide:** New documentation covering [batch operations](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create) including creation, task management, and progress tracking. * **Pricing documentation update:** Updated documentation to reflect current pricing tiers and model options. * **Documentation homepage redesign:** Refreshed homepage design for a better developer experience and easier navigation. * **Transportation data in playgrounds:** Added transportation section to search filters with new data sources (UK National Rail, global vessel tracking) in the API playgrounds. * **Deep Research playground improvements:** Added ISO timestamp support and improved terminology throughout the playground interface. [​](https://docs.valyu.ai/changelog/platform#january-02%2C-2026) January 02, 2026 * **Deliverables in API Playground:** Deep Research deliverables are now available in the API Playground with full preview and file viewing capabilities. * **Guided walkthroughs:** Interactive walkthroughs in the API Playground help you discover and learn features step by step. * **Public report sharing:** Share Deep Research reports publicly, including all generated deliverables and visualizations. * **Downloadable charts:** Export charts generated by Deep Research directly from the platform. * **Dashboard UI refresh:** Visual improvements to the platform dashboard for a cleaner, more intuitive experience. * **Simplified pricing:** Deep Research now uses flat-rate pricing per mode: $100/1K requests for **Fast**, $500/1K for **Standard**, and $1500/1K for **Heavy**, replacing the previous component-based model (AI + search + content costs). [​](https://docs.valyu.ai/changelog/platform#december-26%2C-2025) December 26, 2025 * **Inline chart display:** Generated charts now appear directly within the Deep Research playground, so you can visualize data without leaving the interface. * **Better reasoning visualization:** Research reasoning steps are now displayed with improved clarity, making it easier to follow how Deep Research analyzes and synthesizes information. * **Enhanced mobile experience:** The Deep Research UI is now fully optimized for mobile devices with responsive layouts, touch-friendly controls, and smooth rendering across all screen sizes. * **Defaults updated:** Email notifications and PDF generation are now enabled by default in the Deep Research playground—no extra configuration needed. [​](https://docs.valyu.ai/changelog/platform#december-19%2C-2025) December 19, 2025 * We’ve shipped a new [Collections](https://docs.valyu.ai/search/filtering/collections) feature (currently in beta) to improve the developer experience around managing included sources. Collections let you group data sources such as Valyu datasets, domains, or individual URLs under a single name. You can then reference the collection directly in your queries using included\_sources, for example: `included_sources=["collection:my-finance-sources"]` * On the platform deepresearch playground you can now choose to have an alert sent to you via email upon deepresearch completion. * We have improved PDF generation for deepresearch reports. * On mobile you can now view your deepresearch reports, run new reports, and browse your deepresearch history. * We restructured Deep Research into three research modes: **Fast**, **Standard**, and **Heavy**. * Fast: Ideal for quick answers and lightweight research. Typically completes in ~5 minutes. * Standard: A balanced option for deeper insights without long wait times. Runs for ~10-20 minutes. * Heavy: Designed for in-depth, long-running research tasks. Can run for up to ~90 minutes. [​](https://docs.valyu.ai/changelog/platform#december-12%2C-2025) December 12, 2025 * Users can now authenticate with GitHub on the platform. * We shipped a **Sign in With Valyu** OAuth Server support with consent screens and token management. It’s currently not GA, but will be in a few weeks. Stay tuned! 😉 * There’s now a simplified UI Chat view for non-technical users to explore the Answers playground with inline citations and readable formatting. * All Playgrounds now route users to either chat-style or API-style views based on their technical background. * Responses from Deep Research now include visually formatted inline citations with source links. * Added prediction markets (Kalshi and Polymarket) to the API playground. [​](https://docs.valyu.ai/changelog/platform#december-5%2C-2025) December 5, 2025 * We now display the metadata for structured API responses in search playground dialogs. * We made the transition of Deep Research from closed beta to public beta for all users. * We updated the sample prompts for German labor stats dataset. * We improved news related prompts for the playground. [​](https://docs.valyu.ai/changelog/platform#november-28%2C-2025) November 28, 2025 * We implemented structured output view for deep research results. * We added a streaming view for the answer endpoint in playground. * We added new datasets (including financial and labor statistics) in playground. * We redesigned the billing page. * We implemented inline citation rendering for answer playground. * We improved the mobile view responsiveness of the platform. [​](https://docs.valyu.ai/changelog/platform#november-21%2C-2025) November 21, 2025 * We improved API response handling for finance, answers, and content endpoints. * We made UI improvements to the billing UI and domain access for beta features. * We improved the chat history delete UI for chatbot. [​](https://docs.valyu.ai/changelog/platform#november-14%2C-2025) November 14, 2025 * We added a new chat view for Deep Research. * Users can now share their chats and earn rewards. * We added GPT-5 support as an available model option in the chatbot. * We implemented chat history in the playground interface. * We improved beta user management. * We improved the UI responsiveness of the platform. * We added a better selector UI and default view preferences for Deep Research results. * We optimized content line display for improved readability. * We added a specialized onboarding flow for hackathon participants. [​](https://docs.valyu.ai/changelog/platform#november-7%2C-2025) November 7, 2025 * Introduced persistent chat history for Deep Research sessions with new chat UI. * Added ability to cancel ongoing deep research and follow-up on previous analysis with PDF and chart generation support. * Added new datasets (BioRxiv and MedRxiv) preprint datasets to API playground options for search and answer endpoints. * Optimized API playground layout. * We made some UI improvements to the platform. Was this page helpful? YesNo [Updates & Releases](https://docs.valyu.ai/changelog/sdk-and-api) ⌘I --- # List Datasource Categories | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/datasources-categories#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Datasources List Categories [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) List datasource categories cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/datasources/categories \ --header 'x-api-key: ' 200 401 Copy { "success": true, "categories": [\ {\ "id": "research",\ "name": "Research & Academic",\ "description": "Academic papers and research publications",\ "dataset_count": 4\ },\ {\ "id": "markets",\ "name": "Financial Markets",\ "description": "Real-time and historical market data",\ "dataset_count": 7\ },\ {\ "id": "healthcare",\ "name": "Healthcare & Medical",\ "description": "Clinical trials, drug information, and health data",\ "dataset_count": 4\ }\ ] } GET / v1 / datasources / categories Try it List datasource categories cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/datasources/categories \ --header 'x-api-key: ' 200 401 Copy { "success": true, "categories": [\ {\ "id": "research",\ "name": "Research & Academic",\ "description": "Academic papers and research publications",\ "dataset_count": 4\ },\ {\ "id": "markets",\ "name": "Financial Markets",\ "description": "Real-time and historical market data",\ "dataset_count": 7\ },\ {\ "id": "healthcare",\ "name": "Healthcare & Medical",\ "description": "Clinical trials, drug information, and health data",\ "dataset_count": 4\ }\ ] } #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/datasources-categories#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Response 200 application/json List of categories [​](https://docs.valyu.ai/api-reference/endpoint/datasources-categories#response-success) success boolean Whether the request was successful [​](https://docs.valyu.ai/api-reference/endpoint/datasources-categories#response-categories) categories object\[\] List of available categories Show child attributes Was this page helpful? YesNo [List Datasources](https://docs.valyu.ai/api-reference/endpoint/datasources-list) ⌘I --- # Contents | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/contents#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Web Tools Contents [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) cURL Basic Extraction Copy curl --request POST \ --url https://api.valyu.ai/v1/contents \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "urls": [\ "https://example.com/article1",\ "https://example.com/article2"\ ], "response_length": "medium", "max_price_dollars": 0.1, "extract_effort": "auto", "summary": false } ' 200 Basic Response Copy { "success": true, "error": null, "tx_id": "tx_12345678-1234-1234-1234-123456789abc", "results": [ { "title": "AI Breakthrough in Natural Language Processing", "url": "https://example.com/article1?utm_source=valyu", "content": "# AI Breakthrough in Natural Language Processing\n\nThis article discusses recent breakthroughs in natural language processing, including advances in large language models and their applications in various industries...", "description": "Latest AI developments in NLP technology", "source": "web", "price": 0.002, "length": 12840, "data_type": "unstructured", "image_url": { "main": "https://example.com/hero-image.jpg" } } ], "urls_requested": 1, "urls_processed": 1, "urls_failed": 0, "total_cost_dollars": 0.002, "total_characters": 12840} POST / v1 / contents Try it cURL Basic Extraction Copy curl --request POST \ --url https://api.valyu.ai/v1/contents \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "urls": [\ "https://example.com/article1",\ "https://example.com/article2"\ ], "response_length": "medium", "max_price_dollars": 0.1, "extract_effort": "auto", "summary": false } ' 200 Basic Response Copy { "success": true, "error": null, "tx_id": "tx_12345678-1234-1234-1234-123456789abc", "results": [ { "title": "AI Breakthrough in Natural Language Processing", "url": "https://example.com/article1?utm_source=valyu", "content": "# AI Breakthrough in Natural Language Processing\n\nThis article discusses recent breakthroughs in natural language processing, including advances in large language models and their applications in various industries...", "description": "Latest AI developments in NLP technology", "source": "web", "price": 0.002, "length": 12840, "data_type": "unstructured", "image_url": { "main": "https://example.com/hero-image.jpg" } } ], "urls_requested": 1, "urls_processed": 1, "urls_failed": 0, "total_cost_dollars": 0.002, "total_characters": 12840} #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/contents#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Body application/json [​](https://docs.valyu.ai/api-reference/endpoint/contents#body-urls) urls string\[\] required List of URLs to process (maximum 10 URLs per request) Required array length: `1 - 10` elements Example: [ "https://example.com/article1", "https://example.com/article2"] [​](https://docs.valyu.ai/api-reference/endpoint/contents#body-response-length-one-of-0) response\_length enumintegerenuminteger default:short Content length configuration: * "short": 25,000 characters (good for summaries) * "medium": 50,000 characters (good for articles) * "large": 100,000 characters (good for academic papers) * "max": No character limit * Custom integer: Specific character limit Available options: `short`, `medium`, `large`, `max` Example: `"medium"` [​](https://docs.valyu.ai/api-reference/endpoint/contents#body-max-price-dollars) max\_price\_dollars number Maximum cost limit in dollars for the entire request. If not specified, defaults to 2x the estimated cost. Required range: `x >= 0` Example: `0.1` [​](https://docs.valyu.ai/api-reference/endpoint/contents#body-extract-effort) extract\_effort enum default:normal Processing effort level: * "normal": Fastest extraction speed (Fastest) * "high": Enhanced extraction with better content quality and reliability (Slower) * "auto": Automatically chooses the right effort level (Slowest) Available options: `normal`, `high`, `auto` Example: `"normal"` [​](https://docs.valyu.ai/api-reference/endpoint/contents#body-screenshot) screenshot boolean default:false Request page screenshots. When `true`, each result will include a `screenshot_url` field containing a pre-signed URL to a screenshot image of the page. Screenshots are captured during page rendering. Example: `false` [​](https://docs.valyu.ai/api-reference/endpoint/contents#body-summary-one-of-0) summary booleanstringobjectbooleanstringobject default:false Toggle AI processing (`false` is default) Example: `true` #### Response 200 application/json All URLs processed successfully [​](https://docs.valyu.ai/api-reference/endpoint/contents#response-success) success boolean Whether the request was successful Example: `true` [​](https://docs.valyu.ai/api-reference/endpoint/contents#response-error-one-of-0) error string | null Error message if any issues occurred Example: `null` [​](https://docs.valyu.ai/api-reference/endpoint/contents#response-tx-id) tx\_id string Unique transaction ID for tracking and support Example: `"tx_12345678-1234-1234-1234-123456789abc"` [​](https://docs.valyu.ai/api-reference/endpoint/contents#response-results) results object\[\] Array of processed content results Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/contents#response-urls-requested) urls\_requested integer Number of URLs submitted in the request Required range: `1 <= x <= 10` Example: `2` [​](https://docs.valyu.ai/api-reference/endpoint/contents#response-urls-processed) urls\_processed integer Number of URLs successfully processed Required range: `x >= 0` Example: `2` [​](https://docs.valyu.ai/api-reference/endpoint/contents#response-urls-failed) urls\_failed integer Number of URLs that failed processing Required range: `x >= 0` Example: `0` [​](https://docs.valyu.ai/api-reference/endpoint/contents#response-total-cost-dollars) total\_cost\_dollars number Actual cost charged (only for successful URLs) Required range: `x >= 0` Example: `0.004` [​](https://docs.valyu.ai/api-reference/endpoint/contents#response-total-characters) total\_characters integer Total characters across all processed results Required range: `x >= 0` Example: `25680` Was this page helpful? YesNo [Search](https://docs.valyu.ai/api-reference/endpoint/search) [Answer](https://docs.valyu.ai/api-reference/endpoint/answer) ⌘I --- # Answer | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/answer#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Web Tools Answer [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) cURL Basic Query Copy curl --request POST \ --url https://api.valyu.ai/v1/answer \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "query": "latest developments in quantum computing", "data_max_price": 30 } ' 200 Unstructured Response Copy { "success": true, "tx_id": "tx_12345-abcd-efgh", "original_query": "Latest developments in quantum computing", "contents": "Based on the latest research findings, quantum computing has made significant breakthroughs in 2024. Key developments include advances in quantum error correction, new quantum algorithms for optimization problems, and progress in quantum hardware scalability.", "data_type": "unstructured", "search_results": [ { "title": "Quantum Computing Breakthrough 2024", "url": "https://example.com/quantum-news", "content": "Scientists achieve new milestone in quantum error correction, demonstrating a significant reduction in logical qubit error rates...", "description": "Research paper on quantum computing advances", "source": "web", "source_type": "website", "data_type": "unstructured", "date": "2024-03-15", "length": 2500, "relevance_score": 0.95 } ], "search_metadata": { "tx_ids": [ "search_tx_67890" ], "number_of_results": 8, "total_characters": 45000 }, "ai_usage": { "input_tokens": 1250, "output_tokens": 420 }, "cost": { "total_deduction_dollars": 0.027, "search_deduction_dollars": 0.015, "ai_deduction_dollars": 0.012 }} POST / v1 / answer Try it cURL Basic Query Copy curl --request POST \ --url https://api.valyu.ai/v1/answer \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "query": "latest developments in quantum computing", "data_max_price": 30 } ' 200 Unstructured Response Copy { "success": true, "tx_id": "tx_12345-abcd-efgh", "original_query": "Latest developments in quantum computing", "contents": "Based on the latest research findings, quantum computing has made significant breakthroughs in 2024. Key developments include advances in quantum error correction, new quantum algorithms for optimization problems, and progress in quantum hardware scalability.", "data_type": "unstructured", "search_results": [ { "title": "Quantum Computing Breakthrough 2024", "url": "https://example.com/quantum-news", "content": "Scientists achieve new milestone in quantum error correction, demonstrating a significant reduction in logical qubit error rates...", "description": "Research paper on quantum computing advances", "source": "web", "source_type": "website", "data_type": "unstructured", "date": "2024-03-15", "length": 2500, "relevance_score": 0.95 } ], "search_metadata": { "tx_ids": [ "search_tx_67890" ], "number_of_results": 8, "total_characters": 45000 }, "ai_usage": { "input_tokens": 1250, "output_tokens": 420 }, "cost": { "total_deduction_dollars": 0.027, "search_deduction_dollars": 0.015, "ai_deduction_dollars": 0.012 }} #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/answer#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Body application/json [​](https://docs.valyu.ai/api-reference/endpoint/answer#body-query) query string required The search query Example: `"latest developments in quantum computing"` [​](https://docs.valyu.ai/api-reference/endpoint/answer#body-system-instructions-one-of-0) system\_instructions string | null Custom instructions for AI processing Maximum string length: `2000` Example: `"Focus on practical applications and commercial impact"` [​](https://docs.valyu.ai/api-reference/endpoint/answer#body-structured-output-one-of-0) structured\_output object JSON schema for structured output. When provided, enables JSON mode and returns structured data [​](https://docs.valyu.ai/api-reference/endpoint/answer#body-search-type) search\_type enum default:all Type of search to perform Available options: `all`, `web`, `proprietary`, `news` Example: `"all"` [​](https://docs.valyu.ai/api-reference/endpoint/answer#body-fast-mode) fast\_mode boolean default:false Enable fast mode for reduced latency but shorter results. Best for general purpose queries. Example: `true` [​](https://docs.valyu.ai/api-reference/endpoint/answer#body-data-max-price) data\_max\_price number default:1 Maximum price in dollars for data retrieval (search costs only, does not affect AI costs) Required range: `x >= 0` Example: `1` [​](https://docs.valyu.ai/api-reference/endpoint/answer#body-included-sources) included\_sources string\[\] List of specific sources to search (URLs, domains or dataset names). When a URL or domain path is provided (e.g., '[https://valyu.ai/blog](https://valyu.ai/blog) ' or 'valyu.ai/blog'), only that specific path will be searched. For entire domains, use either the domain name (e.g., 'valyu.ai') or the base URL (e.g., '[https://valyu.ai](https://valyu.ai/) '). Example: [ "https://docs.aws.amazon.com/", "techcrunch.com/news", "valyu/valyu-arxiv"] [​](https://docs.valyu.ai/api-reference/endpoint/answer#body-excluded-sources) excluded\_sources string\[\] List of specific sources to exclude from search (URLs, domains, or dataset names). When a URL or domain path is provided (e.g., '[https://valyu.ai/blog](https://valyu.ai/blog) ' or 'valyu.ai/blog'), only that specific path will be excluded. For entire domains, use either the domain name (e.g., 'valyu.ai') or the base URL (e.g., '[https://valyu.ai](https://valyu.ai/) '). Example: [ "https://news.ycombinator.com/", "github.com/valyu", "valyu/valyu-pubmed"] [​](https://docs.valyu.ai/api-reference/endpoint/answer#body-start-date-one-of-0) start\_date string | null Start date filter (YYYY-MM-DD) Example: `"2024-01-01"` [​](https://docs.valyu.ai/api-reference/endpoint/answer#body-end-date-one-of-0) end\_date string | null End date filter (YYYY-MM-DD) Example: `"2024-12-31"` [​](https://docs.valyu.ai/api-reference/endpoint/answer#body-country-code-one-of-0) country\_code string | null 2-letter ISO country code to bias search results to a specific country Example: `"US"` [​](https://docs.valyu.ai/api-reference/endpoint/answer#body-streaming) streaming boolean default:false Enable Server-Sent Events (SSE) streaming. When true, returns a stream of chunks: search\_results first, then content deltas, then metadata, then \[DONE\]. Example: `false` #### Response 200 application/json Successful AI processing [​](https://docs.valyu.ai/api-reference/endpoint/answer#response-success) success boolean required Whether the request was successful Example: `true` [​](https://docs.valyu.ai/api-reference/endpoint/answer#response-tx-id) tx\_id string required Transaction ID Example: `"tx_12345-abcd-efgh"` [​](https://docs.valyu.ai/api-reference/endpoint/answer#response-original-query) original\_query string required The original search query Example: `"latest developments in quantum computing"` [​](https://docs.valyu.ai/api-reference/endpoint/answer#response-contents-one-of-0) contents stringobjectstringobject required AI-processed response content Example: `"Based on the latest research findings, quantum computing has made significant breakthroughs in 2024..."` [​](https://docs.valyu.ai/api-reference/endpoint/answer#response-data-type) data\_type enum required Type of response data Available options: `unstructured`, `structured` Example: `"unstructured"` [​](https://docs.valyu.ai/api-reference/endpoint/answer#response-search-results) search\_results object\[\] required Search results used for AI processing Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/answer#response-search-metadata) search\_metadata object required Search transaction metadata Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/answer#response-ai-usage) ai\_usage object required AI token usage information Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/answer#response-cost) cost object required Cost breakdown information Show child attributes Was this page helpful? YesNo [Contents](https://docs.valyu.ai/api-reference/endpoint/contents) [Create Task](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create) ⌘I --- # List Datasources | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/datasources-list#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Datasources List Datasources [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) List available datasources cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/datasources \ --header 'x-api-key: ' 200 All Datasources Copy { "success": true, "datasources": [ { "id": "valyu/valyu-arxiv", "name": "Arxiv", "description": "Over 1 million pre-print research papers from physics, computer science, mathematics, and more", "category": "research", "type": "paper", "modality": [ "text", "images" ], "topics": [ "Research Papers", "Computer Science", "Physics" ], "example_queries": [ "What are the latest advancements in self-healing materials?", "How have ML models improved financial risk assessment?" ], "pricing": { "cpm": 0.5 }, "response_schema": { "id": { "type": "string", "description": "Unique identifier" }, "title": { "type": "string", "description": "Document title" }, "content": { "type": "string", "description": "Full text content" }, "authors": { "type": "array", "item_type": "string" } } } ], "total_count": 36, "categories": { "research": { "name": "Research & Academic", "count": 4 }, "markets": { "name": "Financial Markets", "count": 7 } }} GET / v1 / datasources Try it List available datasources cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/datasources \ --header 'x-api-key: ' 200 All Datasources Copy { "success": true, "datasources": [ { "id": "valyu/valyu-arxiv", "name": "Arxiv", "description": "Over 1 million pre-print research papers from physics, computer science, mathematics, and more", "category": "research", "type": "paper", "modality": [ "text", "images" ], "topics": [ "Research Papers", "Computer Science", "Physics" ], "example_queries": [ "What are the latest advancements in self-healing materials?", "How have ML models improved financial risk assessment?" ], "pricing": { "cpm": 0.5 }, "response_schema": { "id": { "type": "string", "description": "Unique identifier" }, "title": { "type": "string", "description": "Document title" }, "content": { "type": "string", "description": "Full text content" }, "authors": { "type": "array", "item_type": "string" } } } ], "total_count": 36, "categories": { "research": { "name": "Research & Academic", "count": 4 }, "markets": { "name": "Financial Markets", "count": 7 } }} #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/datasources-list#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Query Parameters [​](https://docs.valyu.ai/api-reference/endpoint/datasources-list#parameter-category) category enum Filter datasources by category Available options: `research`, `healthcare`, `patents`, `markets`, `company`, `economic`, `predictions`, `transportation`, `legal`, `politics` #### Response 200 application/json List of available datasources [​](https://docs.valyu.ai/api-reference/endpoint/datasources-list#response-success) success boolean Whether the request was successful [​](https://docs.valyu.ai/api-reference/endpoint/datasources-list#response-datasources) datasources object\[\] List of available datasources Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/datasources-list#response-total-count) total\_count integer Total number of datasources returned [​](https://docs.valyu.ai/api-reference/endpoint/datasources-list#response-categories) categories object Summary of categories with counts Show child attributes Was this page helpful? YesNo [Cancel Batch](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-cancel) [List Categories](https://docs.valyu.ai/api-reference/endpoint/datasources-categories) ⌘I --- # DeepResearch - Cancel Batch | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-cancel#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation DeepResearch (Batch) Cancel Batch [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) Cancel a batch cURL Copy curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/batches/{id}/cancel \ --header 'x-api-key: ' 200 401 404 500 Copy { "batch_id": "", "status": "cancelled", "cancelled_count": 123 } POST / v1 / deepresearch / batches / {id} / cancel Try it Cancel a batch cURL Copy curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/batches/{id}/cancel \ --header 'x-api-key: ' 200 401 404 500 Copy { "batch_id": "", "status": "cancelled", "cancelled_count": 123 } #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-cancel#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Path Parameters [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-cancel#parameter-id) id string required Batch ID #### Response 200 application/json Batch cancelled successfully [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-cancel#response-batch-id) batch\_id string Batch ID that was cancelled [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-cancel#response-status) status enum Status of the batch after cancellation Available options: `cancelled` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-cancel#response-cancelled-count) cancelled\_count integer Number of tasks cancelled Was this page helpful? YesNo [List Batch Tasks](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list-tasks) [List Datasources](https://docs.valyu.ai/api-reference/endpoint/datasources-list) ⌘I --- # DeepResearch - List Batches | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation DeepResearch (Batch) List Batches [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) List all batches cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/deepresearch/batches \ --header 'x-api-key: ' 200 401 500 Copy [\ {\ "batch_id": "",\ "status": "open",\ "mode": "standard",\ "counts": {\ "total": 123,\ "queued": 123,\ "running": 123,\ "completed": 123,\ "failed": 123,\ "cancelled": 123\ },\ "cost": 123,\ "created_at": "2023-11-07T05:31:56Z",\ "organisation_id": "",\ "name": "",\ "output_formats": [\ ""\ ],\ "search_params": {\ "search_type": "all",\ "included_sources": [\ ""\ ],\ "excluded_sources": [\ ""\ ],\ "start_date": "2023-12-25",\ "end_date": "2023-12-25",\ "category": ""\ },\ "webhook_url": "",\ "webhook_secret": "",\ "metadata": {},\ "completed_at": "2023-11-07T05:31:56Z"\ }\ ] GET / v1 / deepresearch / batches Try it List all batches cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/deepresearch/batches \ --header 'x-api-key: ' 200 401 500 Copy [\ {\ "batch_id": "",\ "status": "open",\ "mode": "standard",\ "counts": {\ "total": 123,\ "queued": 123,\ "running": 123,\ "completed": 123,\ "failed": 123,\ "cancelled": 123\ },\ "cost": 123,\ "created_at": "2023-11-07T05:31:56Z",\ "organisation_id": "",\ "name": "",\ "output_formats": [\ ""\ ],\ "search_params": {\ "search_type": "all",\ "included_sources": [\ ""\ ],\ "excluded_sources": [\ ""\ ],\ "start_date": "2023-12-25",\ "end_date": "2023-12-25",\ "category": ""\ },\ "webhook_url": "",\ "webhook_secret": "",\ "metadata": {},\ "completed_at": "2023-11-07T05:31:56Z"\ }\ ] #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Response 200 application/json List of batches retrieved successfully [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-batch-id) batch\_id string required Unique batch identifier [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-status) status enum required Current batch status Available options: `open`, `processing`, `completed`, `completed_with_errors`, `cancelled` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-mode) mode enum required DeepResearch mode for all tasks in this batch Available options: `standard`, `heavy`, `fast` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-counts) counts object required Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-cost) cost number required Total cost in dollars [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-created-at) created\_at string required Batch creation timestamp [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-organisation-id) organisation\_id string Organization ID that owns this batch [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-name) name string Optional batch name [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-output-formats) output\_formats (string | object)\[\] Default output formats for tasks [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-search-params) search\_params object Default search configuration Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-webhook-url) webhook\_url string Webhook URL for completion notifications [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-webhook-secret) webhook\_secret string Secret for webhook signature verification. Only present in batch creation responses. [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-metadata) metadata object Custom metadata Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list#response-items-completed-at) completed\_at string Completion timestamp (if completed) Was this page helpful? YesNo [Create Batch](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create) [Get Batch Status](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status) ⌘I --- # DeepResearch - Add Tasks to Batch | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-add-tasks#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation DeepResearch (Batch) Add Tasks to Batch [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) Add tasks to batch cURL Copy curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/batches/{id}/tasks \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "tasks": [\ {\ "id": "tech_sector",\ "query": "Analyze technology sector performance in Q4 2024"\ },\ {\ "id": "healthcare_sector",\ "query": "Research healthcare sector trends and key players",\ "urls": [\ "https://healthcare-report.com/q4-2024"\ ]\ },\ {\ "id": "energy_sector",\ "query": "Review renewable energy market developments",\ "strategy": "Focus on solar and wind energy only"\ }\ ] } ' 202 400 401 404 500 Copy { "batch_id": "", "added": 123, "tasks": [\ {\ "task_id": "",\ "deepresearch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",\ "status": "queued",\ "query": "Analyze technology sector performance in Q4 2024",\ "created_at": "2023-11-07T05:31:56Z",\ "completed_at": "2023-11-07T05:31:56Z"\ }\ ], "counts": { "total": 123, "queued": 123, "running": 123, "completed": 123, "failed": 123, "cancelled": 123 } } POST / v1 / deepresearch / batches / {id} / tasks Try it Add tasks to batch cURL Copy curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/batches/{id}/tasks \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "tasks": [\ {\ "id": "tech_sector",\ "query": "Analyze technology sector performance in Q4 2024"\ },\ {\ "id": "healthcare_sector",\ "query": "Research healthcare sector trends and key players",\ "urls": [\ "https://healthcare-report.com/q4-2024"\ ]\ },\ {\ "id": "energy_sector",\ "query": "Review renewable energy market developments",\ "strategy": "Focus on solar and wind energy only"\ }\ ] } ' 202 400 401 404 500 Copy { "batch_id": "", "added": 123, "tasks": [\ {\ "task_id": "",\ "deepresearch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",\ "status": "queued",\ "query": "Analyze technology sector performance in Q4 2024",\ "created_at": "2023-11-07T05:31:56Z",\ "completed_at": "2023-11-07T05:31:56Z"\ }\ ], "counts": { "total": 123, "queued": 123, "running": 123, "completed": 123, "failed": 123, "cancelled": 123 } } #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-add-tasks#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Path Parameters [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-add-tasks#parameter-id) id string required Batch ID #### Body application/json [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-add-tasks#body-tasks) tasks object\[\] required Array of tasks to add to the batch (1-100 tasks per request) Required array length: `1 - 100` elements Show child attributes #### Response 202 application/json Tasks added successfully (accepted for processing) [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-add-tasks#response-batch-id) batch\_id string Batch ID [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-add-tasks#response-added) added integer Number of tasks successfully added [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-add-tasks#response-tasks) tasks object\[\] Array of tasks that were added Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-add-tasks#response-counts) counts object Updated task counts for the batch Show child attributes Was this page helpful? YesNo [Get Batch Status](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status) [List Batch Tasks](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list-tasks) ⌘I --- # DeepResearch - Get Batch Status | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation DeepResearch (Batch) Get Batch Status [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) Get batch status cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/deepresearch/batches/{id} \ --header 'x-api-key: ' 200 401 404 500 Copy { "batch_id": "", "status": "open", "mode": "standard", "counts": { "total": 123, "queued": 123, "running": 123, "completed": 123, "failed": 123, "cancelled": 123 }, "cost": 123, "created_at": "2023-11-07T05:31:56Z", "organisation_id": "", "name": "", "output_formats": [\ ""\ ], "search_params": { "search_type": "all", "included_sources": [\ ""\ ], "excluded_sources": [\ ""\ ], "start_date": "2023-12-25", "end_date": "2023-12-25", "category": "" }, "webhook_url": "", "webhook_secret": "", "metadata": {}, "completed_at": "2023-11-07T05:31:56Z" } GET / v1 / deepresearch / batches / {id} Try it Get batch status cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/deepresearch/batches/{id} \ --header 'x-api-key: ' 200 401 404 500 Copy { "batch_id": "", "status": "open", "mode": "standard", "counts": { "total": 123, "queued": 123, "running": 123, "completed": 123, "failed": 123, "cancelled": 123 }, "cost": 123, "created_at": "2023-11-07T05:31:56Z", "organisation_id": "", "name": "", "output_formats": [\ ""\ ], "search_params": { "search_type": "all", "included_sources": [\ ""\ ], "excluded_sources": [\ ""\ ], "start_date": "2023-12-25", "end_date": "2023-12-25", "category": "" }, "webhook_url": "", "webhook_secret": "", "metadata": {}, "completed_at": "2023-11-07T05:31:56Z" } #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Path Parameters [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#parameter-id) id string required Batch ID #### Response 200 application/json Batch status retrieved successfully [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-batch-id) batch\_id string required Unique batch identifier [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-status) status enum required Current batch status Available options: `open`, `processing`, `completed`, `completed_with_errors`, `cancelled` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-mode) mode enum required DeepResearch mode for all tasks in this batch Available options: `standard`, `heavy`, `fast` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-counts) counts object required Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-cost) cost number required Total cost in dollars [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-created-at) created\_at string required Batch creation timestamp [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-organisation-id) organisation\_id string Organization ID that owns this batch [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-name) name string Optional batch name [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-output-formats) output\_formats (string | object)\[\] Default output formats for tasks [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-search-params) search\_params object Default search configuration Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-webhook-url) webhook\_url string Webhook URL for completion notifications [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-webhook-secret) webhook\_secret string Secret for webhook signature verification. Only present in batch creation responses. [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-metadata) metadata object Custom metadata Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-status#response-completed-at) completed\_at string Completion timestamp (if completed) Was this page helpful? YesNo [List Batches](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list) [Add Tasks to Batch](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-add-tasks) ⌘I --- # DeepResearch - Cancel Task | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepresearch-cancel#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation DeepResearch Cancel Task [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) Cancel task cURL Copy curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/tasks/{id}/cancel \ --header 'x-api-key: ' 200 400 401 403 404 500 Copy { "success": true, "message": "Research cancelled", "deepresearch_id": "f992a8ab-4c91-4322-905f-190107bd5a5b" } POST / v1 / deepresearch / tasks / {id} / cancel Try it Cancel task cURL Copy curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/tasks/{id}/cancel \ --header 'x-api-key: ' 200 400 401 403 404 500 Copy { "success": true, "message": "Research cancelled", "deepresearch_id": "f992a8ab-4c91-4322-905f-190107bd5a5b" } #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-cancel#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Path Parameters [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-cancel#parameter-id) id string required Deep research task ID (UUID) #### Response 200 application/json Task cancelled successfully [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-cancel#response-success) success boolean Whether the operation was successful [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-cancel#response-message) message string Status message [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-cancel#response-deepresearch-id) deepresearch\_id string Task identifier Was this page helpful? YesNo [Update Task](https://docs.valyu.ai/api-reference/endpoint/deepresearch-update) [Delete Task](https://docs.valyu.ai/api-reference/endpoint/deepresearch-delete) ⌘I --- # DeepResearch - List Batch Tasks | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list-tasks#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation DeepResearch (Batch) List Batch Tasks [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) List batch tasks cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/deepresearch/batches/{id}/tasks \ --header 'x-api-key: ' 200 401 404 500 Copy { "batch_id": "", "tasks": [\ {\ "task_id": "",\ "deepresearch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",\ "status": "queued",\ "query": "Analyze technology sector performance in Q4 2024",\ "created_at": "2023-11-07T05:31:56Z",\ "completed_at": "2023-11-07T05:31:56Z"\ }\ ], "pagination": { "count": 123, "last_key": "", "has_more": true } } GET / v1 / deepresearch / batches / {id} / tasks Try it List batch tasks cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/deepresearch/batches/{id}/tasks \ --header 'x-api-key: ' 200 401 404 500 Copy { "batch_id": "", "tasks": [\ {\ "task_id": "",\ "deepresearch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",\ "status": "queued",\ "query": "Analyze technology sector performance in Q4 2024",\ "created_at": "2023-11-07T05:31:56Z",\ "completed_at": "2023-11-07T05:31:56Z"\ }\ ], "pagination": { "count": 123, "last_key": "", "has_more": true } } #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list-tasks#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Path Parameters [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list-tasks#parameter-id) id string required Batch ID #### Response 200 application/json Tasks retrieved successfully [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list-tasks#response-batch-id) batch\_id string Batch ID [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list-tasks#response-tasks) tasks object\[\] Array of tasks in the batch Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list-tasks#response-pagination) pagination object Pagination information Show child attributes Was this page helpful? YesNo [Add Tasks to Batch](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-add-tasks) [Cancel Batch](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-cancel) ⌘I --- # DeepResearch - List Tasks | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepresearch-list#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation DeepResearch List Tasks [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) List tasks cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/deepresearch/list \ --header 'x-api-key: ' 200 400 401 500 Copy [\ {\ "deepresearch_id": "f992a8ab-4c91-4322-905f-190107bd5a5b",\ "query": "What are the latest developments in quantum computing?",\ "status": "completed",\ "created_at": "2025-01-15T10:30:00.000Z",\ "public": false\ }\ ] GET / v1 / deepresearch / list Try it List tasks cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/deepresearch/list \ --header 'x-api-key: ' 200 400 401 500 Copy [\ {\ "deepresearch_id": "f992a8ab-4c91-4322-905f-190107bd5a5b",\ "query": "What are the latest developments in quantum computing?",\ "status": "completed",\ "created_at": "2025-01-15T10:30:00.000Z",\ "public": false\ }\ ] #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-list#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Query Parameters [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-list#parameter-api-key-id) api\_key\_id string required API key ID to list tasks for [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-list#parameter-limit) limit integer default:100 Maximum number of tasks to return (1-100) Required range: `1 <= x <= 100` #### Response 200 application/json Tasks retrieved successfully [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-list#response-items-deepresearch-id) deepresearch\_id string Unique task identifier [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-list#response-items-query) query string Original research query [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-list#response-items-status) status enum Current task status Available options: `queued`, `running`, `completed`, `failed`, `cancelled` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-list#response-items-created-at) created\_at integer Unix timestamp when task was created [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-list#response-items-public) public boolean Whether the task is publicly accessible Was this page helpful? YesNo [Get Status](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status) [Update Task](https://docs.valyu.ai/api-reference/endpoint/deepresearch-update) ⌘I --- # DeepResearch - Create Batch | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation DeepResearch (Batch) Create Batch [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) cURL Basic Batch Copy curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/batches \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "name": "Q4 Market Analysis", "mode": "standard" } ' 201 400 401 500 Copy { "batch_id": "", "status": "open", "mode": "standard", "counts": { "total": 123, "queued": 123, "running": 123, "completed": 123, "failed": 123, "cancelled": 123 }, "cost": 123, "created_at": "2023-11-07T05:31:56Z", "organisation_id": "", "name": "", "output_formats": [\ ""\ ], "search_params": { "search_type": "all", "included_sources": [\ ""\ ], "excluded_sources": [\ ""\ ], "start_date": "2023-12-25", "end_date": "2023-12-25", "category": "" }, "webhook_url": "", "webhook_secret": "", "metadata": {}, "completed_at": "2023-11-07T05:31:56Z" } POST / v1 / deepresearch / batches Try it cURL Basic Batch Copy curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/batches \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "name": "Q4 Market Analysis", "mode": "standard" } ' 201 400 401 500 Copy { "batch_id": "", "status": "open", "mode": "standard", "counts": { "total": 123, "queued": 123, "running": 123, "completed": 123, "failed": 123, "cancelled": 123 }, "cost": 123, "created_at": "2023-11-07T05:31:56Z", "organisation_id": "", "name": "", "output_formats": [\ ""\ ], "search_params": { "search_type": "all", "included_sources": [\ ""\ ], "excluded_sources": [\ ""\ ], "start_date": "2023-12-25", "end_date": "2023-12-25", "category": "" }, "webhook_url": "", "webhook_secret": "", "metadata": {}, "completed_at": "2023-11-07T05:31:56Z" } #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Body application/json [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#body-name) name string Optional name for the batch Example: `"Q4 Market Analysis"` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#body-mode) mode enum default:standard DeepResearch mode for all tasks in this batch Available options: `standard`, `heavy`, `fast` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#body-output-formats) output\_formats (string | object)\[\] Default output formats for all tasks (markdown, pdf, toon, or structured JSON schema). Cannot mix JSON schema with markdown/pdf. toon requires a JSON schema. [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#body-search) search object Search configuration applied to all tasks in the batch (cannot be overridden per task) Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#body-webhook-url) webhook\_url string HTTPS URL to receive notifications when the batch completes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#body-metadata) metadata object Custom metadata for tracking and organization Show child attributes #### Response 201 application/json Batch created successfully [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-batch-id) batch\_id string required Unique batch identifier [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-status) status enum required Current batch status Available options: `open`, `processing`, `completed`, `completed_with_errors`, `cancelled` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-mode) mode enum required DeepResearch mode for all tasks in this batch Available options: `standard`, `heavy`, `fast` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-counts) counts object required Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-cost) cost number required Total cost in dollars [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-created-at) created\_at string required Batch creation timestamp [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-organisation-id) organisation\_id string Organization ID that owns this batch [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-name) name string Optional batch name [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-output-formats) output\_formats (string | object)\[\] Default output formats for tasks [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-search-params) search\_params object Default search configuration Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-webhook-url) webhook\_url string Webhook URL for completion notifications [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-webhook-secret) webhook\_secret string Secret for webhook signature verification. Only present in batch creation responses. [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-metadata) metadata object Custom metadata Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create#response-completed-at) completed\_at string Completion timestamp (if completed) Was this page helpful? YesNo [Delete Task](https://docs.valyu.ai/api-reference/endpoint/deepresearch-delete) [List Batches](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-list) ⌘I --- # DeepResearch - Delete Task | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepresearch-delete#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation DeepResearch Delete Task [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) Delete task cURL Copy curl --request DELETE \ --url https://api.valyu.ai/v1/deepresearch/tasks/{id}/delete \ --header 'x-api-key: ' 200 400 401 403 404 500 Copy { "success": true, "message": "Task deleted successfully", "deepresearch_id": "f992a8ab-4c91-4322-905f-190107bd5a5b" } DELETE / v1 / deepresearch / tasks / {id} / delete Try it Delete task cURL Copy curl --request DELETE \ --url https://api.valyu.ai/v1/deepresearch/tasks/{id}/delete \ --header 'x-api-key: ' 200 400 401 403 404 500 Copy { "success": true, "message": "Task deleted successfully", "deepresearch_id": "f992a8ab-4c91-4322-905f-190107bd5a5b" } #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-delete#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Path Parameters [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-delete#parameter-id) id string required Deep research task ID (UUID) #### Response 200 application/json Task deleted successfully [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-delete#response-success) success boolean Whether the operation was successful [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-delete#response-message) message string Status message [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-delete#response-deepresearch-id) deepresearch\_id string Task identifier Was this page helpful? YesNo [Cancel Task](https://docs.valyu.ai/api-reference/endpoint/deepresearch-cancel) [Create Batch](https://docs.valyu.ai/api-reference/endpoint/deepresearch-batch-create) ⌘I --- # DeepResearch - Get Status | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation DeepResearch Get Status [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) Get task status cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/deepresearch/tasks/{id}/status \ --header 'x-api-key: ' 200 Running Copy { "deepresearch_id": "f992a8ab-4c91-4322-905f-190107bd5a5b", "status": "running", "query": "What are the latest developments in quantum computing?", "mode": "standard", "output_formats": [\ "markdown"\ ], "created_at": "2025-01-15T10:30:00.000Z", "public": false, "progress": { "current_step": 2, "total_steps": 10 } } GET / v1 / deepresearch / tasks / {id} / status Try it Get task status cURL Copy curl --request GET \ --url https://api.valyu.ai/v1/deepresearch/tasks/{id}/status \ --header 'x-api-key: ' 200 Running Copy { "deepresearch_id": "f992a8ab-4c91-4322-905f-190107bd5a5b", "status": "running", "query": "What are the latest developments in quantum computing?", "mode": "standard", "output_formats": [\ "markdown"\ ], "created_at": "2025-01-15T10:30:00.000Z", "public": false, "progress": { "current_step": 2, "total_steps": 10 } } #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Path Parameters [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#parameter-id) id string required Deep research task ID (UUID) #### Response 200 application/json Task status retrieved successfully [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-deepresearch-id) deepresearch\_id string Unique task identifier [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-status) status enum Current task status Available options: `queued`, `running`, `completed`, `failed`, `cancelled` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-query) query string Original research query [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-mode) mode enum Research mode used Available options: `fast`, `standard`, `heavy` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-output-formats) output\_formats array Requested output formats [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-created-at) created\_at string ISO 8601 timestamp when task was created [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-public) public boolean Whether the task is publicly accessible [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-progress) progress object Progress information (present when running) Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-output-type) output\_type enum Output type (present when completed) Available options: `markdown`, `json`, `toon` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-output-one-of-0) output stringobjectstringobject Research output - markdown string or structured JSON (present when completed) [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-sources) sources object\[\] Sources used in the research (present when completed) Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-cost) cost number Fixed cost for the research task based on mode: $0.10 (fast), $0.50 (standard), $1.50 (heavy) [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-completed-at) completed\_at string ISO 8601 timestamp when task completed [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-pdf-url) pdf\_url string Pre-signed URL for PDF download (if PDF was requested) [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-images) images object\[\] Generated images (charts, AI-generated) Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-deliverables) deliverables object\[\] Generated deliverable files (CSV, Excel, PowerPoint, Word, PDF) Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-error) error string Error message (present when failed) [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-batch-id) batch\_id string Batch ID if task belongs to a batch [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status#response-batch-task-id) batch\_task\_id string Batch task identifier if task belongs to a batch Was this page helpful? YesNo [Create Task](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create) [List Tasks](https://docs.valyu.ai/api-reference/endpoint/deepresearch-list) ⌘I --- # DeepResearch - Create Task | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation DeepResearch Create Task [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) cURL Basic Research Copy curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/tasks \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "query": "What are the latest developments in quantum computing?", "mode": "standard" } ' 202 Task Created Copy { "deepresearch_id": "f992a8ab-4c91-4322-905f-190107bd5a5b", "status": "running", "mode": "standard", "created_at": "2025-01-15T10:30:00.000Z", "metadata": {}, "public": false, "webhook_secret": "a1b2c3d4e5f6..."} POST / v1 / deepresearch / tasks Try it cURL Basic Research Copy curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/tasks \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "query": "What are the latest developments in quantum computing?", "mode": "standard" } ' 202 Task Created Copy { "deepresearch_id": "f992a8ab-4c91-4322-905f-190107bd5a5b", "status": "running", "mode": "standard", "created_at": "2025-01-15T10:30:00.000Z", "metadata": {}, "public": false, "webhook_secret": "a1b2c3d4e5f6..."} #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Body application/json [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-query) query string required Research query or task description Example: `"What are the key differences between RAG and fine-tuning for LLMs?"` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-mode) mode enum default:standard DeepResearch mode: * fast: Ideal for quicker answers and lightweight research. Typically completes in ~2–5 minutes. * standard: A balanced option for deeper insights without long wait times. Runs for ~10–20 minutes. * heavy: Designed for in-depth, long-running research tasks. Can run for up to ~90 minutes. Available options: `fast`, `standard`, `heavy` Example: `"standard"` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-model) model enum default:standard DeepResearch mode (deprecated, use 'mode' instead) Available options: `fast`, `standard`, `heavy` Example: `"standard"` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-output-formats) output\_formats (enum | object)\[\] Output formats. Use \['markdown'\], \['markdown', 'pdf'\], or a JSON schema object for structured output. Cannot mix JSON schema with markdown/pdf. Available options: `markdown`, `pdf`, `toon` Example: ["markdown"] [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-strategy-one-of-0) strategy string | null Natural language strategy instructions prepended to the system prompt Example: `"Focus on peer-reviewed sources and recent publications"` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-search) search object Search configuration parameters Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-urls) urls string\[\] URLs to extract content from (max 10) Maximum array length: `10` Example: ["https://example.com/article"] [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-files) files object\[\] File attachments (PDFs, images, documents). Max 10 files. Maximum array length: `10` Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-mcp-servers) mcp\_servers object\[\] MCP server configurations for custom tools (max 5 servers) Maximum array length: `5` Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-code-execution) code\_execution boolean default:true Enable/disable code execution during research [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-previous-reports) previous\_reports string\[\] Previous deep research IDs to use as context (max 3) Maximum array length: `3` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-webhook-url) webhook\_url string HTTPS URL for webhook notifications. When provided, Valyu will POST the full task result to this URL when the task completes or fails. The request includes X-Webhook-Signature and X-Webhook-Timestamp headers for verification. HTTP URLs are rejected—only HTTPS is supported. [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-metadata) metadata object Custom metadata for tracking Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#body-deliverables) deliverables (string | object)\[\] Additional file outputs to generate from the research (CSV, Excel, PowerPoint, Word, PDF). Max 10 deliverables. Maximum array length: `10` Simple deliverable description (e.g., 'Excel file with company data') Example: [ { "type": "xlsx", "description": "Extract all company names, founding years, and revenue data into a spreadsheet" }] #### Response 202 application/json Task created successfully [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#response-deepresearch-id) deepresearch\_id string Unique task identifier Example: `"f992a8ab-4c91-4322-905f-190107bd5a5b"` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#response-status) status enum Current task status Available options: `queued`, `running`, `completed`, `failed`, `cancelled` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#response-mode) mode enum Research mode used Available options: `fast`, `standard`, `heavy` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#response-model) model enum Research mode used (deprecated, use 'mode' instead) Available options: `fast`, `standard`, `heavy` [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#response-created-at) created\_at string Task creation timestamp [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#response-metadata) metadata object Custom metadata provided with the request [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#response-public) public boolean Whether the task is publicly accessible [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#response-webhook-secret) webhook\_secret string 32-byte cryptographic secret (64-character hex string) for verifying webhook signatures. Only returned once in the creation response—store it securely. Use this secret to verify the HMAC-SHA256 signature in the X-Webhook-Signature header of incoming webhook requests. [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-create#response-message) message string Additional status message (e.g., if queued) Was this page helpful? YesNo [Answer](https://docs.valyu.ai/api-reference/endpoint/answer) [Get Status](https://docs.valyu.ai/api-reference/endpoint/deepresearch-status) ⌘I --- # DeepResearch - Update Task | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepresearch-update#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation DeepResearch Update Task [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) Add follow-up instruction cURL Copy curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/tasks/{id}/update \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "instruction": "Focus more on recent developments from 2024 onwards" } ' 200 400 401 403 404 500 Copy { "success": true, "message": "Instruction added", "deepresearch_id": "f992a8ab-4c91-4322-905f-190107bd5a5b" } POST / v1 / deepresearch / tasks / {id} / update Try it Add follow-up instruction cURL Copy curl --request POST \ --url https://api.valyu.ai/v1/deepresearch/tasks/{id}/update \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "instruction": "Focus more on recent developments from 2024 onwards" } ' 200 400 401 403 404 500 Copy { "success": true, "message": "Instruction added", "deepresearch_id": "f992a8ab-4c91-4322-905f-190107bd5a5b" } #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-update#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Path Parameters [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-update#parameter-id) id string required Deep research task ID (UUID) #### Body application/json [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-update#body-instruction) instruction string required Follow-up instruction to add to the running task. Must be submitted before the writing phase begins. Example: `"Focus more on recent developments from 2024 onwards"` #### Response 200 application/json Instruction added successfully [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-update#response-success) success boolean Whether the operation was successful [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-update#response-message) message string Status message [​](https://docs.valyu.ai/api-reference/endpoint/deepresearch-update#response-deepresearch-id) deepresearch\_id string Task identifier Was this page helpful? YesNo [List Tasks](https://docs.valyu.ai/api-reference/endpoint/deepresearch-list) [Cancel Task](https://docs.valyu.ai/api-reference/endpoint/deepresearch-cancel) ⌘I --- # Python Quickstart | Valyu [Skip to main content](https://docs.valyu.ai/sdk/python-sdk#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Python SDK Python Quickstart [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) On this page * [Features](https://docs.valyu.ai/sdk/python-sdk#features) * [Installation](https://docs.valyu.ai/sdk/python-sdk#installation) * [Authentication](https://docs.valyu.ai/sdk/python-sdk#authentication) * [Environment Variable (Recommended)](https://docs.valyu.ai/sdk/python-sdk#environment-variable-recommended) * [Direct API Key](https://docs.valyu.ai/sdk/python-sdk#direct-api-key) * [Quick Start](https://docs.valyu.ai/sdk/python-sdk#quick-start) * [Error Handling](https://docs.valyu.ai/sdk/python-sdk#error-handling) * [Next Steps](https://docs.valyu.ai/sdk/python-sdk#next-steps) * [Support](https://docs.valyu.ai/sdk/python-sdk#support) The Valyu Python SDK provides comprehensive access to all Valyu APIs, enabling you to build powerful AI applications with search, content extraction, answer generation, and deep research capabilities. [​](https://docs.valyu.ai/sdk/python-sdk#features) Features -------------------------------------------------------------- The SDK includes four core APIs: * **[Search API](https://docs.valyu.ai/sdk/python-sdk/search) ** - Advanced search across web and proprietary data sources * **[Contents API](https://docs.valyu.ai/sdk/python-sdk/contents) ** - Extract and process content from URLs with AI * **[Answer API](https://docs.valyu.ai/sdk/python-sdk/answer) ** - AI-powered answer generation with search integration * **[DeepResearch API](https://docs.valyu.ai/sdk/python-sdk/deepresearch) ** - Async deep research with comprehensive reports [​](https://docs.valyu.ai/sdk/python-sdk#installation) Installation ---------------------------------------------------------------------- Install the Valyu Python SDK using pip: Copy pip install valyu [​](https://docs.valyu.ai/sdk/python-sdk#authentication) Authentication -------------------------------------------------------------------------- Get your API key from [Valyu Platform](https://platform.valyu.ai/) (free $10 credits included). Set up authentication in one of two ways: ### [​](https://docs.valyu.ai/sdk/python-sdk#environment-variable-recommended) Environment Variable (Recommended) Copy export VALYU_API_KEY="your-api-key-here" Copy from valyu import Valyu # Automatically uses VALYU_API_KEY from environment valyu = Valyu() ### [​](https://docs.valyu.ai/sdk/python-sdk#direct-api-key) Direct API Key Copy from valyu import Valyu valyu = Valyu("your-api-key-here") [​](https://docs.valyu.ai/sdk/python-sdk#quick-start) Quick Start -------------------------------------------------------------------- Here’s a simple example to get you started with search: Copy from valyu import Valyu valyu = Valyu() # Basic search example search_response = valyu.search( "What are the latest developments in quantum computing?" ) print(f"Found {len(search_response.results)} results") for result in search_response.results: print(f"Title: {result.title}") print(f"URL: {result.url}") print(f"Content preview: {result.content[:200]}...") [​](https://docs.valyu.ai/sdk/python-sdk#error-handling) Error Handling -------------------------------------------------------------------------- The SDK includes built-in error handling and validation: Copy response = valyu.search("test query") if not response.success: print("Search failed:", response.error) return # Process successful results for result in response.results: # Handle each result pass [​](https://docs.valyu.ai/sdk/python-sdk#next-steps) Next Steps ------------------------------------------------------------------ Explore the detailed documentation for each API: [Search API\ ----------\ \ Advanced search across web and proprietary sources](https://docs.valyu.ai/sdk/python-sdk/search) [Contents API\ ------------\ \ Extract and process web content with AI](https://docs.valyu.ai/sdk/python-sdk/contents) [Answer API\ ----------\ \ Generate AI-powered answers with search](https://docs.valyu.ai/sdk/python-sdk/answer) [DeepResearch API\ ----------------\ \ Async deep research with comprehensive reports](https://docs.valyu.ai/sdk/python-sdk/deepresearch) [​](https://docs.valyu.ai/sdk/python-sdk#support) Support ------------------------------------------------------------ * **Discord**: [Join our community](https://discord.gg/umtmSsppRY) * **GitHub**: [valyu-network/valyu-py](https://github.com/valyu-network/valyu-py) * **Support**: [\[email protected\]](https://docs.valyu.ai/cdn-cgi/l/email-protection#dcbfb3b2a8bdbfa89caabdb0a5a9f2bdb5) Was this page helpful? YesNo [Search API](https://docs.valyu.ai/sdk/python-sdk/search) ⌘I --- # Design Assets | Valyu [Skip to main content](https://docs.valyu.ai/assets/valyu-assets#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Other Design Assets [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) On this page * [Overview](https://docs.valyu.ai/assets/valyu-assets#overview) * [Logos](https://docs.valyu.ai/assets/valyu-assets#logos) * [Logo Icon](https://docs.valyu.ai/assets/valyu-assets#logo-icon) * [White Logo](https://docs.valyu.ai/assets/valyu-assets#white-logo) * [Black Logo](https://docs.valyu.ai/assets/valyu-assets#black-logo) [​](https://docs.valyu.ai/assets/valyu-assets#overview) Overview ------------------------------------------------------------------- Welcome to the Valyu design assets library. This page provides official brand assets including logos, icons, and other design resources for developers, partners, and media. All assets are provided for use in accordance with our brand guidelines. [​](https://docs.valyu.ai/assets/valyu-assets#logos) Logos ------------------------------------------------------------- ### [​](https://docs.valyu.ai/assets/valyu-assets#logo-icon) Logo Icon The Valyu icon is perfect for app icons, favicons, and compact spaces. **Icon - Black**![Valyu Logo Icon - Black](https://mintcdn.com/valyu/iPfDcFdyV62DT0f2/logo/ValyuLg-Black.png?w=2500&fit=max&auto=format&n=iPfDcFdyV62DT0f2&q=85&s=e109b76649670f5db9c8ca71c2ab6cc5)[Download PNG](https://docs.valyu.ai/logo/ValyuLg-Black.png) **Icon - White**![Valyu Logo Icon - White](https://mintcdn.com/valyu/iPfDcFdyV62DT0f2/logo/ValyuLg-white.png?w=2500&fit=max&auto=format&n=iPfDcFdyV62DT0f2&q=85&s=6988333222c4aa6b492860b44e34803f)[Download PNG](https://docs.valyu.ai/logo/ValyuLg-white.png) ### [​](https://docs.valyu.ai/assets/valyu-assets#white-logo) White Logo **White Logo**![Valyu Logo White](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?w=2500&fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=bbe25b50227208d103247d34de03f1b8)[Download PNG](https://docs.valyu.ai/logo/valyu-logo.png) ### [​](https://docs.valyu.ai/assets/valyu-assets#black-logo) Black Logo Use the black logo on light or white backgrounds. **Black Logo**![Valyu Logo Black](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?w=2500&fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=b3cacded22a49f17ca676413b47e8883)[Download PNG](https://docs.valyu.ai/logo/valyu-logo-dark.png) Was this page helpful? YesNo [Powered by Valyu Badge](https://docs.valyu.ai/guides/badge) ⌘I --- # Build with Valyu | Valyu [Skip to main content](https://docs.valyu.ai/home#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Getting Started Build with Valyu [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) Build with Valyu ================ The search API built for AI agents. Installation [Python SDK\ ----------\ \ Copy\ \ pip install valyu](https://docs.valyu.ai/sdk/python-sdk) [JavaScript SDK\ --------------\ \ Copy\ \ npm install valyu-js](https://docs.valyu.ai/sdk/typescript-sdk) * Search the web * Extract content * Get answers * Deep research Search the web and other data sources for relevant information and context for your AI agents.Copy prompt Python JavaScript cURL Copy from valyu import Valyu client = Valyu(api_key="your-api-key") response = client.search( query="Latest AI inference datacenter projects", search_type="all", max_num_results=10 ) print(response) [Learn more about the Search API →](https://docs.valyu.ai/api-reference/endpoint/search) Extract and summarise content from any URL.Copy prompt Python JavaScript cURL Copy from valyu import Valyu client = Valyu(api_key="your-api-key") response = client.contents( urls=["https://a16z.com/search-wars-episode-2/"] extract_effort="auto" ) print(response) [Learn more about the Contents API →](https://docs.valyu.ai/api-reference/endpoint/contents) Get AI answers grounded by our search.Copy prompt Python JavaScript cURL Copy from valyu import Valyu client = Valyu(api_key="your-api-key") response = client.answer( query="What data sources can Valyu AI search over?" ) print(response.answer) [Learn more about the Answer API →](https://docs.valyu.ai/api-reference/endpoint/answer) Let AI search and research for you, delivering comprehensive reports.Copy prompt Python JavaScript cURL Copy from valyu import Valyu client = Valyu(api_key="your-api-key") # Start a research task task = client.deepresearch.create( query="Analyze the impact of AI on healthcare" ) # Check status status = client.deepresearch.status(task.task_id) print(status) [Learn more about DeepResearch →](https://docs.valyu.ai/guides/deepresearch) Start Building [Quickstart & Use Cases\ ----------------------\ \ Get up and running in minutes with step-by-step guides and real-world examples](https://docs.valyu.ai/quickstart) [API Playground\ --------------\ \ Test Valyu APIs interactively and explore responses in real-time](https://platform.valyu.ai/) [Pricing\ -------\ \ Simple, transparent pay-per-use pricing with $10 free credits to start](https://docs.valyu.ai/pricing) [Contact Us](https://docs.valyu.ai/cdn-cgi/l/email-protection#57343839233634231721363b2e2279363e) [Twitter](https://x.com/valyuofficial) [Join our Discord](https://discord.gg/umtmSsppRY) [GitHub](https://github.com/valyu-network) [LinkedIn](https://linkedin.com/company/valyu-ai) ⌘I --- # LM Studio Plugin | Valyu [Skip to main content](https://docs.valyu.ai/integrations/lmstudio#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Agents & MCP LM Studio Plugin [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) On this page * [Overview](https://docs.valyu.ai/integrations/lmstudio#overview) * [Quick Start](https://docs.valyu.ai/integrations/lmstudio#quick-start) * [1\. Install the Plugin](https://docs.valyu.ai/integrations/lmstudio#1-install-the-plugin) * [2\. Get Your API Key](https://docs.valyu.ai/integrations/lmstudio#2-get-your-api-key) * [3\. Add Your API Key](https://docs.valyu.ai/integrations/lmstudio#3-add-your-api-key) * [Using the Plugin](https://docs.valyu.ai/integrations/lmstudio#using-the-plugin) * [Recommended Models](https://docs.valyu.ai/integrations/lmstudio#recommended-models) * [Troubleshooting](https://docs.valyu.ai/integrations/lmstudio#troubleshooting) * [Support](https://docs.valyu.ai/integrations/lmstudio#support) [​](https://docs.valyu.ai/integrations/lmstudio#overview) Overview --------------------------------------------------------------------- The Valyu plugin enables your local LLMs in LM Studio to search the web and fetch webpage content in real-time. [​](https://docs.valyu.ai/integrations/lmstudio#quick-start) Quick Start --------------------------------------------------------------------------- ### [​](https://docs.valyu.ai/integrations/lmstudio#1-install-the-plugin) 1\. Install the Plugin Install directly from the LM Studio Hub: [https://lmstudio.ai/valyu/valyu](https://lmstudio.ai/valyu/valyu) ### [​](https://docs.valyu.ai/integrations/lmstudio#2-get-your-api-key) 2\. Get Your API Key Sign up for a free API key with $10 credit: [https://platform.valyu.ai](https://platform.valyu.ai/) ### [​](https://docs.valyu.ai/integrations/lmstudio#3-add-your-api-key) 3\. Add Your API Key Open the plugin settings in LM Studio and paste your API key. [​](https://docs.valyu.ai/integrations/lmstudio#using-the-plugin) Using the Plugin ------------------------------------------------------------------------------------- The plugin adds two tools your model can use: * **valyu\_deepsearch** - Search the web for current information * **valyu\_contents** - Extract content from any URL Just ask questions naturally: * “What’s the latest news about quantum computing?” * “Find recent research on transformer models” * “Get Tesla’s current stock price” [​](https://docs.valyu.ai/integrations/lmstudio#recommended-models) Recommended Models ----------------------------------------------------------------------------------------- **Important:** Not all models work well with tool calling. Use these tested model families for best results: * **Qwen** - Excellent tool calling support * **Gemma** - Reliable tool execution * **Granite** - Strong performance Smaller models (under 7B parameters) often struggle with tool calling and may get stuck in loops repeatedly calling the search tools. [​](https://docs.valyu.ai/integrations/lmstudio#troubleshooting) Troubleshooting ----------------------------------------------------------------------------------- **Plugin not working?** * Verify your API key is correct * Try a larger model (7B+) * Use one of the recommended model families **Model keeps calling tools repeatedly?** * Switch to a more capable model * Try Qwen, Gemma, or Granite families [​](https://docs.valyu.ai/integrations/lmstudio#support) Support ------------------------------------------------------------------- Need help? Join our Discord: [https://discord.gg/umtmSsppRY](https://discord.gg/umtmSsppRY) Was this page helpful? YesNo [Claude Code Plugin](https://docs.valyu.ai/integrations/claude-code-plugin) [AWS Bedrock AgentCore](https://docs.valyu.ai/integrations/aws-agentcore) ⌘I --- # Search | Valyu [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/search#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Web Tools Search [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) cURL Basic Query Copy curl --request POST \ --url https://api.valyu.ai/v1/search \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "query": "latest developments in quantum computing" } ' 200 Basic Search Response Copy { "success": true, "error": null, "tx_id": "tx_12345678-1234-1234-1234-123456789abc", "results": [ { "title": "Quantum Computing Breakthrough: New Error Correction Method", "url": "https://nature.com/articles/quantum-error-correction-2024?utm_source=valyu", "content": "Researchers at MIT have developed a revolutionary quantum error correction method that reduces error rates by 90% while maintaining computational speed. This breakthrough addresses one of the fundamental challenges in scaling quantum computers...", "description": "Major breakthrough in quantum error correction methodology", "source": "academic", "price": 0.005, "length": 15420, "data_type": "unstructured", "source_type": "paper", "publication_date": "2024-03-15", "id": "https://nature.com/articles/quantum-error-correction-2024", "image_url": { "main": "https://nature.com/quantum-diagram.jpg" } }, { "title": "IBM Announces 1000-Qubit Quantum Processor", "url": "https://techcrunch.com/2024/05/12/ibm-quantum-1000-qubit?utm_source=valyu", "content": "IBM has unveiled its latest quantum processor featuring over 1000 qubits, marking a significant milestone in quantum computing hardware development. The new processor, called Condor, demonstrates improved coherence times and reduced error rates...", "description": "IBM's latest quantum hardware milestone announcement", "source": "web", "price": 0.003, "length": 8950, "data_type": "unstructured", "source_type": "website", "publication_date": "2024-05-12", "id": "https://techcrunch.com/2024/05/12/ibm-quantum-1000-qubit", "image_url": { "main": "https://techcrunch.com/ibm-quantum-chip.jpg" } } ], "total_results": 25, "results_returned": 2, "total_cost_dollars": 0.008, "total_characters": 24370} POST / v1 / search Try it cURL Basic Query Copy curl --request POST \ --url https://api.valyu.ai/v1/search \ --header 'Content-Type: application/json' \ --header 'x-api-key: ' \ --data ' { "query": "latest developments in quantum computing" } ' 200 Basic Search Response Copy { "success": true, "error": null, "tx_id": "tx_12345678-1234-1234-1234-123456789abc", "results": [ { "title": "Quantum Computing Breakthrough: New Error Correction Method", "url": "https://nature.com/articles/quantum-error-correction-2024?utm_source=valyu", "content": "Researchers at MIT have developed a revolutionary quantum error correction method that reduces error rates by 90% while maintaining computational speed. This breakthrough addresses one of the fundamental challenges in scaling quantum computers...", "description": "Major breakthrough in quantum error correction methodology", "source": "academic", "price": 0.005, "length": 15420, "data_type": "unstructured", "source_type": "paper", "publication_date": "2024-03-15", "id": "https://nature.com/articles/quantum-error-correction-2024", "image_url": { "main": "https://nature.com/quantum-diagram.jpg" } }, { "title": "IBM Announces 1000-Qubit Quantum Processor", "url": "https://techcrunch.com/2024/05/12/ibm-quantum-1000-qubit?utm_source=valyu", "content": "IBM has unveiled its latest quantum processor featuring over 1000 qubits, marking a significant milestone in quantum computing hardware development. The new processor, called Condor, demonstrates improved coherence times and reduced error rates...", "description": "IBM's latest quantum hardware milestone announcement", "source": "web", "price": 0.003, "length": 8950, "data_type": "unstructured", "source_type": "website", "publication_date": "2024-05-12", "id": "https://techcrunch.com/2024/05/12/ibm-quantum-1000-qubit", "image_url": { "main": "https://techcrunch.com/ibm-quantum-chip.jpg" } } ], "total_results": 25, "results_returned": 2, "total_cost_dollars": 0.008, "total_characters": 24370} #### Authorizations [​](https://docs.valyu.ai/api-reference/endpoint/search#authorization-x-api-key) x-api-key string header required Your Valyu API key. Get one at platform.valyu.ai #### Body application/json Search parameters for context retrieval [​](https://docs.valyu.ai/api-reference/endpoint/search#body-query) query string required The query string for the search Example: `"implementation of agentic search-enhanced large reasoning models"` [​](https://docs.valyu.ai/api-reference/endpoint/search#body-max-num-results) max\_num\_results integer default:10 Maximum number of results to return (1-20 for standard API keys, up to 100 with a [special API key](http://platform.valyu.ai/user/account/apikeys?req=increase_results) ) Required range: `1 <= x <= 100` Example: `10` [​](https://docs.valyu.ai/api-reference/endpoint/search#body-search-type) search\_type enum default:all Type of search to perform.'web' searches and returns web content. 'proprietary' uses Valyu's full-text multimodal indicies (arxiv/pubmed/proprietary academic content). 'news' searches and returns only news articles. Available options: `all`, `web`, `proprietary`, `news` Example: `"all"` [​](https://docs.valyu.ai/api-reference/endpoint/search#body-fast-mode) fast\_mode boolean default:false Enable fast mode for reduced latency but shorter results. Best for general purpose queries. Example: `true` [​](https://docs.valyu.ai/api-reference/endpoint/search#body-max-price) max\_price number Maximum price in dollars for a thousand retrievals (CPM). Only applies when provided. If not provided, adjusts automatically based on search type and max number of results. Required range: `x >= 0` Example: `30` [​](https://docs.valyu.ai/api-reference/endpoint/search#body-relevance-threshold) relevance\_threshold number default:0.5 Minimum relevance score for results (0.0-1.0) Required range: `0 <= x <= 1` Example: `0.5` [​](https://docs.valyu.ai/api-reference/endpoint/search#body-included-sources) included\_sources string\[\] List of specific sources to search (URLs, domains or dataset names). When a URL or domain path is provided (e.g., '[https://valyu.ai/blog](https://valyu.ai/blog) ' or 'valyu.ai/blog'), only that specific path will be searched. For entire domains, use either the domain name (e.g., 'valyu.ai') or the base URL (e.g., '[https://valyu.ai](https://valyu.ai/) '). Example: [ "https://docs.aws.amazon.com/", "techcrunch.com/news", "valyu/valyu-arxiv"] [​](https://docs.valyu.ai/api-reference/endpoint/search#body-excluded-sources) excluded\_sources string\[\] List of specific sources to exclude from search (URLs, domains, or dataset names). When a URL or domain path is provided (e.g., '[https://valyu.ai/blog](https://valyu.ai/blog) ' or 'valyu.ai/blog'), only that specific path will be excluded. For entire domains, use either the domain name (e.g., 'valyu.ai') or the base URL (e.g., '[https://valyu.ai](https://valyu.ai/) '). Example: [ "https://news.ycombinator.com/", "github.com/valyu", "valyu/valyu-pubmed"] [​](https://docs.valyu.ai/api-reference/endpoint/search#body-category-one-of-0) category string | null Natural language category/guide phrase to help guide the search to the most relevant content. For example 'agentic use-cases Example: `"agentic use-cases"` [​](https://docs.valyu.ai/api-reference/endpoint/search#body-response-length-one-of-0) response\_length integerenumintegerenum default:short Controls the length of content returned per result. Can be an integer for character count or predefined values: 'short' (25k), 'medium' (50k), 'large' (100k), 'max' (full) Required range: `x >= 1` Example: `"short"` [​](https://docs.valyu.ai/api-reference/endpoint/search#body-country-code-one-of-0) country\_code string | null 2-letter ISO country code to bias search results to a specific country Example: `"US"` [​](https://docs.valyu.ai/api-reference/endpoint/search#body-is-tool-call) is\_tool\_call boolean default:true Tunes retrieval process based on whether the API is being called by an AI agent as a tool call, or a user query. Example: `false` [​](https://docs.valyu.ai/api-reference/endpoint/search#body-start-date-one-of-0) start\_date string | null Start date for time-filtered searches (YYYY-MM-DD) Example: `"2024-01-01"` [​](https://docs.valyu.ai/api-reference/endpoint/search#body-end-date-one-of-0) end\_date string | null End date for time-filtered searches (YYYY-MM-DD) Example: `"2024-12-31"` [​](https://docs.valyu.ai/api-reference/endpoint/search#body-url-only) url\_only boolean default:false When set to true, only returns URLs for results (no content). Only applies when search\_type is 'web' or 'news'. Example: `true` #### Response 200 application/json Successful response with search results [​](https://docs.valyu.ai/api-reference/endpoint/search#response-success) success boolean required Whether the request was successful Example: `true` [​](https://docs.valyu.ai/api-reference/endpoint/search#response-error) error string required Error message (empty if successful). Will show reason for failure or if there are an recommendations to improve the search results (e.g. 'max price too low, 5 results removed') - this can be fed to agents to assist in autonomous agentic workflows Example: `""` [​](https://docs.valyu.ai/api-reference/endpoint/search#response-tx-id) tx\_id string required Unique transaction ID for this request Example: `"tx_12345678-1234-1234-1234-123456789abc"` [​](https://docs.valyu.ai/api-reference/endpoint/search#response-query) query string required The query string for the search Example: `"implementation of agentic search-enhanced large reasoning models"` [​](https://docs.valyu.ai/api-reference/endpoint/search#response-results) results object\[\] required Array of search result objects. The results are sorted by relevance. Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/search#response-results-by-source) results\_by\_source object required Count of results by source type Show child attributes [​](https://docs.valyu.ai/api-reference/endpoint/search#response-total-deduction-pcm) total\_deduction\_pcm number required Total cost in cost per mille Example: `150` [​](https://docs.valyu.ai/api-reference/endpoint/search#response-total-deduction-dollars) total\_deduction\_dollars number required Total cost in dollars Example: `0.15` [​](https://docs.valyu.ai/api-reference/endpoint/search#response-total-characters) total\_characters integer required Total character count of all results Example: `12500` Was this page helpful? YesNo [Contents](https://docs.valyu.ai/api-reference/endpoint/contents) ⌘I --- # Rust Quickstart | Valyu [Skip to main content](https://docs.valyu.ai/sdk/rust-sdk#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Rust SDK (Alpha) Rust Quickstart [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) On this page * [Features](https://docs.valyu.ai/sdk/rust-sdk#features) * [Installation](https://docs.valyu.ai/sdk/rust-sdk#installation) * [Authentication](https://docs.valyu.ai/sdk/rust-sdk#authentication) * [Environment Variable (Recommended)](https://docs.valyu.ai/sdk/rust-sdk#environment-variable-recommended) * [Direct API Key](https://docs.valyu.ai/sdk/rust-sdk#direct-api-key) * [Using .env File](https://docs.valyu.ai/sdk/rust-sdk#using-env-file) * [Quick Start](https://docs.valyu.ai/sdk/rust-sdk#quick-start) * [Error Handling](https://docs.valyu.ai/sdk/rust-sdk#error-handling) * [Custom HTTP Client](https://docs.valyu.ai/sdk/rust-sdk#custom-http-client) * [Next Steps](https://docs.valyu.ai/sdk/rust-sdk#next-steps) * [Support](https://docs.valyu.ai/sdk/rust-sdk#support) The Valyu Rust SDK provides comprehensive access to Valyu APIs, enabling you to build powerful AI applications with search, content extraction, and answer generation capabilities. This SDK is currently in **alpha**. The API is stable, but some features and interfaces may change based on user feedback. [​](https://docs.valyu.ai/sdk/rust-sdk#features) Features ------------------------------------------------------------ The SDK includes three core APIs: * **[Search API](https://docs.valyu.ai/sdk/rust-sdk/search) ** - Advanced search across web and proprietary data sources * **[Contents API](https://docs.valyu.ai/sdk/rust-sdk/contents) ** - Extract and process content from URLs with AI * **[Answer API](https://docs.valyu.ai/sdk/rust-sdk/answer) ** - AI-powered answer generation with search integration Key SDK features: * **Type-safe API** - Full type coverage with serde support for all endpoints * **Async/await** - Built on tokio and reqwest for efficient async operations * **Builder pattern** - Fluent interface for constructing complex requests * **Comprehensive error handling** - Detailed error types for all failure scenarios [​](https://docs.valyu.ai/sdk/rust-sdk#installation) Installation -------------------------------------------------------------------- Add this to your `Cargo.toml`: Copy [dependencies] valyu = "0.2" tokio = { version = "1", features = ["full"] } [​](https://docs.valyu.ai/sdk/rust-sdk#authentication) Authentication ------------------------------------------------------------------------ Get your API key from [Valyu Platform](https://platform.valyu.ai/) (free $10 credits included). Set up authentication in one of two ways: ### [​](https://docs.valyu.ai/sdk/rust-sdk#environment-variable-recommended) Environment Variable (Recommended) Copy export VALYU_API_KEY="your-api-key-here" Copy use std::env; use valyu::ValyuClient; let api_key = env::var("VALYU_API_KEY").expect("VALYU_API_KEY must be set"); let client = ValyuClient::new(api_key); ### [​](https://docs.valyu.ai/sdk/rust-sdk#direct-api-key) Direct API Key Copy use valyu::ValyuClient; let client = ValyuClient::new("your-api-key-here"); ### [​](https://docs.valyu.ai/sdk/rust-sdk#using-env-file) Using .env File For local development, use the `dotenvy` crate: Copy [dependencies] dotenvy = "0.15" Copy use std::env; use valyu::ValyuClient; #[tokio::main] async fn main() -> Result<(), Box> { dotenvy::dotenv().ok(); let api_key = env::var("VALYU_API_KEY")?; let client = ValyuClient::new(api_key); Ok(()) } [​](https://docs.valyu.ai/sdk/rust-sdk#quick-start) Quick Start ------------------------------------------------------------------ Here’s a simple example to get you started with search: Copy use valyu::ValyuClient; #[tokio::main] async fn main() -> Result<(), Box> { let client = ValyuClient::new("your-api-key"); // Basic search example let response = client.search("What are the latest developments in quantum computing?").await?; if let Some(results) = &response.results { println!("Found {} results", results.len()); for result in results { println!("Title: {}", result.title.as_deref().unwrap_or("Untitled")); println!("URL: {}", result.url.as_deref().unwrap_or("No URL")); if let Some(content) = &result.content { println!("Content preview: {}...", &content[..200.min(content.len())]); } } } Ok(()) } [​](https://docs.valyu.ai/sdk/rust-sdk#error-handling) Error Handling ------------------------------------------------------------------------ The SDK includes built-in error handling with the `ValyuError` type: Copy use valyu::{ValyuClient, ValyuError}; #[tokio::main] async fn main() { let client = ValyuClient::new("your-api-key"); match client.search("test").await { Ok(response) => { if response.success { println!("Success! Found {} results", response.results.as_ref().map(|r| r.len()).unwrap_or(0)); } else { eprintln!("API returned error: {:?}", response.error); } } Err(ValyuError::InvalidApiKey) => eprintln!("Invalid API key provided"), Err(ValyuError::RateLimitExceeded) => eprintln!("Rate limit exceeded - please retry later"), Err(ValyuError::ServiceUnavailable) => eprintln!("Service temporarily unavailable"), Err(ValyuError::InvalidRequest(msg)) => eprintln!("Invalid request: {}", msg), Err(e) => eprintln!("Error: {}", e), } } [​](https://docs.valyu.ai/sdk/rust-sdk#custom-http-client) Custom HTTP Client -------------------------------------------------------------------------------- Configure custom timeouts and other HTTP settings: Copy use valyu::ValyuClient; use std::time::Duration; let http_client = reqwest::Client::builder() .timeout(Duration::from_secs(30)) .build() .unwrap(); let client = ValyuClient::with_client("your-api-key", http_client); [​](https://docs.valyu.ai/sdk/rust-sdk#next-steps) Next Steps ---------------------------------------------------------------- Explore the detailed documentation for each API: [Search API\ ----------\ \ Advanced search across web and proprietary sources](https://docs.valyu.ai/sdk/rust-sdk/search) [Contents API\ ------------\ \ Extract and process web content with AI](https://docs.valyu.ai/sdk/rust-sdk/contents) [Answer API\ ----------\ \ Generate AI-powered answers with search](https://docs.valyu.ai/sdk/rust-sdk/answer) [​](https://docs.valyu.ai/sdk/rust-sdk#support) Support ---------------------------------------------------------- * **Discord**: [Join our community](https://discord.gg/umtmSsppRY) * **GitHub**: [valyu-network/valyu-rust](https://github.com/valyu-network/valyu-rust) * **Crate Documentation**: [docs.rs/valyu](https://docs.rs/valyu) * **Support**: [\[email protected\]](https://docs.valyu.ai/cdn-cgi/l/email-protection#b3d0dcddc7d2d0c7f3c5d2dfcac69dd2da) Was this page helpful? YesNo [Datasources API](https://docs.valyu.ai/sdk/typescript-sdk/datasources) [Search API](https://docs.valyu.ai/sdk/rust-sdk/search) ⌘I --- # TypeScript Quickstart | Valyu [Skip to main content](https://docs.valyu.ai/sdk/typescript-sdk#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation TypeScript SDK TypeScript Quickstart [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) On this page * [Features](https://docs.valyu.ai/sdk/typescript-sdk#features) * [Installation](https://docs.valyu.ai/sdk/typescript-sdk#installation) * [Authentication](https://docs.valyu.ai/sdk/typescript-sdk#authentication) * [Environment Variable (Recommended)](https://docs.valyu.ai/sdk/typescript-sdk#environment-variable-recommended) * [Direct API Key](https://docs.valyu.ai/sdk/typescript-sdk#direct-api-key) * [Quick Start](https://docs.valyu.ai/sdk/typescript-sdk#quick-start) * [Error Handling](https://docs.valyu.ai/sdk/typescript-sdk#error-handling) * [Next Steps](https://docs.valyu.ai/sdk/typescript-sdk#next-steps) * [Support](https://docs.valyu.ai/sdk/typescript-sdk#support) The Valyu TypeScript SDK provides comprehensive access to all Valyu APIs, enabling you to build powerful AI applications with search, content extraction, answer generation, and deep research capabilities. [​](https://docs.valyu.ai/sdk/typescript-sdk#features) Features ------------------------------------------------------------------ The SDK includes four core APIs: * **[Search API](https://docs.valyu.ai/sdk/typescript-sdk/search) ** - Advanced search across web and proprietary data sources * **[Contents API](https://docs.valyu.ai/sdk/typescript-sdk/contents) ** - Extract and process content from URLs with AI * **[Answer API](https://docs.valyu.ai/sdk/typescript-sdk/answer) ** - AI-powered answer generation with search integration * **[DeepResearch API](https://docs.valyu.ai/sdk/typescript-sdk/deepresearch) ** - Async deep research with comprehensive reports [​](https://docs.valyu.ai/sdk/typescript-sdk#installation) Installation -------------------------------------------------------------------------- Install the Valyu TypeScript SDK using your preferred package manager: npm yarn pnpm Copy npm install valyu-js [​](https://docs.valyu.ai/sdk/typescript-sdk#authentication) Authentication ------------------------------------------------------------------------------ Get your API key from [Valyu Platform](https://platform.valyu.ai/) (free $10 credits included). Set up authentication in one of two ways: ### [​](https://docs.valyu.ai/sdk/typescript-sdk#environment-variable-recommended) Environment Variable (Recommended) Copy export VALYU_API_KEY="your-api-key-here" Copy import { Valyu } from "valyu-js"; // Automatically uses VALYU_API_KEY from environment const valyu = new Valyu(); ### [​](https://docs.valyu.ai/sdk/typescript-sdk#direct-api-key) Direct API Key Copy import { Valyu } from "valyu-js"; const valyu = new Valyu("your-api-key-here"); [​](https://docs.valyu.ai/sdk/typescript-sdk#quick-start) Quick Start ------------------------------------------------------------------------ Here’s a simple example to get you started with search: Copy import { Valyu } from "valyu-js"; const valyu = new Valyu(); // Basic search example const searchResponse = await valyu.search( "What are the latest developments in quantum computing?" ); console.log(`Found ${searchResponse.results.length} results`); searchResponse.results.forEach(result => { console.log(`Title: ${result.title}`); console.log(`URL: ${result.url}`); console.log(`Content preview: ${result.content.substring(0, 200)}...`); }); [​](https://docs.valyu.ai/sdk/typescript-sdk#error-handling) Error Handling ------------------------------------------------------------------------------ The SDK includes built-in error handling and validation: Copy const response = await valyu.search("test query"); if (!response.success) { console.error("Search failed:", response.error); return; } // Process successful results response.results.forEach(result => { // Handle each result }); [​](https://docs.valyu.ai/sdk/typescript-sdk#next-steps) Next Steps ---------------------------------------------------------------------- Explore the detailed documentation for each API: [Search API\ ----------\ \ Advanced search across web and proprietary sources](https://docs.valyu.ai/sdk/typescript-sdk/search) [Contents API\ ------------\ \ Extract and process web content with AI](https://docs.valyu.ai/sdk/typescript-sdk/contents) [Answer API\ ----------\ \ Generate AI-powered answers with search](https://docs.valyu.ai/sdk/typescript-sdk/answer) [DeepResearch API\ ----------------\ \ Async deep research with comprehensive reports](https://docs.valyu.ai/sdk/typescript-sdk/deepresearch) [​](https://docs.valyu.ai/sdk/typescript-sdk#support) Support ---------------------------------------------------------------- * **Discord**: [Join our community](https://discord.gg/umtmSsppRY) * **GitHub**: [valyu-network/valyu-js](https://github.com/valyu-network/valyu-js) * **Support**: [\[email protected\]](https://docs.valyu.ai/cdn-cgi/l/email-protection#43202c2d372220370335222f3a366d222a) Was this page helpful? YesNo [Datasources API](https://docs.valyu.ai/sdk/python-sdk/datasources) [Search API](https://docs.valyu.ai/sdk/typescript-sdk/search) ⌘I --- # Data Coverage | Valyu [Skip to main content](https://docs.valyu.ai/concepts/data-coverage#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Core Concepts Data Coverage [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) On this page * [Available Datasets](https://docs.valyu.ai/concepts/data-coverage#available-datasets) * [Research & Academic](https://docs.valyu.ai/concepts/data-coverage#research-%26-academic) * [Healthcare & Life Sciences](https://docs.valyu.ai/concepts/data-coverage#healthcare-%26-life-sciences) * [Financial Markets](https://docs.valyu.ai/concepts/data-coverage#financial-markets) * [Company Fundamentals](https://docs.valyu.ai/concepts/data-coverage#company-fundamentals) * [Economic Data](https://docs.valyu.ai/concepts/data-coverage#economic-data) * [Prediction Markets](https://docs.valyu.ai/concepts/data-coverage#prediction-markets) * [Transportation](https://docs.valyu.ai/concepts/data-coverage#transportation) * [Patents & IP](https://docs.valyu.ai/concepts/data-coverage#patents-%26-ip) * [Domain Coverage Summary](https://docs.valyu.ai/concepts/data-coverage#domain-coverage-summary) * [Research Coverage](https://docs.valyu.ai/concepts/data-coverage#research-coverage) * [Coming Soon](https://docs.valyu.ai/concepts/data-coverage#coming-soon) Valyu’s Search API provides access to millions of documents across academic, research, financial, healthcare, and other domains. We index both open-access repositories and premium proprietary sources. All sources are continuously updated with real-time indexing and automated ingestion. We also provide web search alongside these data sources for the latest news and information. Want a source added? Contact us at [\[email protected\]](https://docs.valyu.ai/cdn-cgi/l/email-protection#07646869736664734771666b7e7229666e) . [​](https://docs.valyu.ai/concepts/data-coverage#available-datasets) Available Datasets ------------------------------------------------------------------------------------------ Below are the specific datasets available through Valyu. Use the `included_sources` parameter to target specific datasets, or let Valyu automatically select the most relevant sources for your query. ### [​](https://docs.valyu.ai/concepts/data-coverage#research-&-academic) Research & Academic | **Dataset** | **Description** | **Size** | **Updates** | | --- | --- | --- | --- | | `valyu/valyu-arxiv` | Pre-print research papers from physics, CS, mathematics, quantitative finance, and economics | 2.5M+ papers | Monthly | | `valyu/valyu-pubmed` | Open access biomedical and life sciences literature covering medicine, genetics, pharmacology, and epidemiology | 37M+ papers | Monthly | | `valyu/valyu-biorxiv` | Life sciences preprints covering neuroscience, molecular biology, bioinformatics, and computational biology | 250K+ papers | Monthly | | `valyu/valyu-medrxiv` | Health and clinical research preprints spanning clinical medicine, epidemiology, public health, and oncology | 80K+ papers | Monthly | ### [​](https://docs.valyu.ai/concepts/data-coverage#healthcare-&-life-sciences) Healthcare & Life Sciences | **Dataset** | **Description** | **Size** | **Updates** | | --- | --- | --- | --- | | `valyu/valyu-clinical-trials` | Clinical studies from ClinicalTrials.gov including study design, eligibility, outcomes, and results | 500K+ trials | Real-time | | `valyu/valyu-drug-labels` | FDA-approved medication labeling from DailyMed including dosage, warnings, and interactions | 150K+ labels | Real-time | | `valyu/valyu-chembl` | Bioactive molecules database from ChEMBL with drug-like properties, bioactivity data, and target information | 2.5M+ compounds | Monthly | | `valyu/valyu-drugbank` | Comprehensive drug database from DrugBank with mechanisms, targets, pharmacology, and interactions | 15K+ drugs | Monthly | | `valyu/valyu-open-targets` | Drug target validation platform with disease associations, genetic evidence, and target tractability data | 60K+ targets | Monthly | | `valyu/valyu-npi-registry` | US National Provider Identifier registry with healthcare provider details, specialties, and practice locations | 8M+ providers | Real-time | | `valyu/valyu-who-icd` | WHO International Classification of Diseases with ICD-10 and ICD-11 codes for diagnosis and billing | 70K+ codes | Monthly | | `valyu/valyu-nih-grants` | NIH research funding data including project descriptions, investigators, and funding amounts | 2M+ grants | Real-time | | `valyu/valyu-who-health-data` | Global health statistics from WHO covering 194 countries with disease, health system, and demographic data | 5M+ records | Real-time | ### [​](https://docs.valyu.ai/concepts/data-coverage#financial-markets) Financial Markets | **Dataset** | **Description** | **Size** | **Updates** | | --- | --- | --- | --- | | `valyu/valyu-stocks` | Real-time and historical stock prices across 75 exchanges globally | 200K+ stocks | Real-time | | `valyu/valyu-crypto` | Real-time cryptocurrency prices including open, high, low, close, volume, and market cap | 200+ coins | Real-time | | `valyu/valyu-forex` | Foreign exchange rates for currency pairs worldwide | 180+ pairs | Real-time | | `valyu/valyu-etfs` | Exchange-traded fund prices and data globally | 25K+ ETFs | Real-time | | `valyu/valyu-funds` | Mutual fund prices and metadata | 10K+ funds | Real-time | | `valyu/valyu-commodities` | Commodity futures prices including oil, gold, metals, and agriculture | 60+ commodities | Real-time | | `valyu/valyu-market-movers-US` | Biggest gainers, losers, and most active stocks in US markets | Daily | Daily | ### [​](https://docs.valyu.ai/concepts/data-coverage#company-fundamentals) Company Fundamentals | **Dataset** | **Description** | **Size** | **Updates** | | --- | --- | --- | --- | | `valyu/valyu-sec-filings` | SEC regulatory documents including 10-K, 10-Q, and 8-K filings with semantic search | 3M+ filings | Daily | | `valyu/valyu-earnings-US` | Quarterly and annual earnings data including EPS, revenue, and analyst estimates | 10K+ companies | Real-time | | `valyu/valyu-balance-sheet-US` | Balance sheet data including assets, liabilities, equity, and debt | 10K+ companies | Quarterly | | `valyu/valyu-income-statement-US` | Income statement data including revenue, gross profit, and net income | 10K+ companies | Quarterly | | `valyu/valyu-cash-flow-US` | Cash flow statements including operating, investing, and financing flows | 10K+ companies | Quarterly | | `valyu/valyu-dividends-US` | Dividend payment history including amounts, ex-dates, and payment dates | 10K+ companies | Daily | | `valyu/valyu-statistics-US` | Key financial metrics including P/E, market cap, beta, and ROE | 10K+ companies | Daily | | `valyu/valyu-insider-transactions-US` | Insider trading activity by executives, directors, and major shareholders | 10K+ companies | Daily | ### [​](https://docs.valyu.ai/concepts/data-coverage#economic-data) Economic Data | **Dataset** | **Description** | **Size** | **Updates** | | --- | --- | --- | --- | | `valyu/valyu-fred` | Federal Reserve Economic Data with 800K+ time series covering GDP, inflation, interest rates, and more | 50M+ records | Real-time | | `valyu/valyu-bls` | Bureau of Labor Statistics data on employment, wages, CPI, and productivity | 10M+ records | Real-time | | `valyu/valyu-destatis-labor` | German labour market statistics from Destatis including employment, wages, and regional data | 15M+ records | Monthly | | `valyu/valyu-worldbank-indicators` | World Bank development indicators for 200+ countries covering economic, social, and environmental metrics | 2M+ records | Real-time | | `valyu/valyu-usaspending` | US federal spending data including contracts, grants, and awards across all agencies | 40M+ records | Real-time | ### [​](https://docs.valyu.ai/concepts/data-coverage#prediction-markets) Prediction Markets | **Dataset** | **Description** | **Size** | **Updates** | | --- | --- | --- | --- | | `valyu/valyu-polymarket` | Polymarket prediction market data including events, prices, volumes, and liquidity | 100K+ markets | Real-time | | `valyu/valyu-kalshi` | Kalshi prediction market data including events, outcomes, and pricing | 100K+ markets | Real-time | ### [​](https://docs.valyu.ai/concepts/data-coverage#transportation) Transportation | **Dataset** | **Description** | **Size** | **Updates** | | --- | --- | --- | --- | | `valyu/valyu-global-ship-tracking` | Real-time vessel positions and AIS data for ships worldwide including speed, heading, and status | 5M+ vessels | Real-time | | `valyu/valyu-uk-national-rail` | Live UK train departures, arrivals, platform info, delays, and cancellations | 1M+ records | Real-time | ### [​](https://docs.valyu.ai/concepts/data-coverage#patents-&-ip) Patents & IP | **Dataset** | **Description** | **Size** | **Updates** | | --- | --- | --- | --- | | `valyu/valyu-patents` | US patent filings from 2001 onwards including utility, design, and plant patents | 8M+ patents | Weekly | * * * [​](https://docs.valyu.ai/concepts/data-coverage#domain-coverage-summary) Domain Coverage Summary ---------------------------------------------------------------------------------------------------- ### [​](https://docs.valyu.ai/concepts/data-coverage#research-coverage) Research Coverage | **Domain** | **Description** | **Coverage** | | --- | --- | --- | | **Natural Sciences** | Physics, chemistry, biology, astronomy, earth sciences | High | | **Mathematics & Statistics** | Pure/applied maths, statistics, probability | High | | **Computer Science** | AI, ML, software, systems, HCI, security | High | | **Engineering** | Electrical, mechanical, civil, materials | Medium | | **Psychology & Cognitive Sciences** | Human behaviour, cognition, neuroscience | Medium | | **Social Sciences** | Sociology, politics, education, law | Low | | **Humanities** | History, philosophy, literature, religion | Low | | **Environmental & Earth Sciences** | Climate, ecology, geology, oceans | Medium | | **Medical & Health Sciences** | Clinical medicine, public health, biomedicine | High | | **Business & Management** | Finance, marketing, strategy, accounting | High | ### [​](https://docs.valyu.ai/concepts/data-coverage#coming-soon) Coming Soon | **Data Type** | **Description** | **Status** | | --- | --- | --- | | **International Markets** | Stock data for European, Asian, and emerging markets | Coming Soon | | **Flight Data** | Real-time and historical flight tracking, schedules, and aviation data | Coming Soon | | **Trucking & Freight** | Logistics, freight rates, and trucking industry data | Coming Soon | | **Additional Economic Data** | Trade statistics, housing data, and regional economic indicators | Coming Soon | | **Additional Drug Data** | Drug adverse events and pharmaceutical pipelines | Coming Soon | | **UK Legislation** | UK laws and legal documents | Coming Soon | | **Private Company Data** | Startup profiles, valuations, funding rounds | On the Roadmap | * * * _Data coverage statistics updated daily. Contact us at [\[email protected\]](https://docs.valyu.ai/cdn-cgi/l/email-protection#05666a6b71646671457364697c702b646c) for specific domain requirements or custom data partnerships._ Was this page helpful? YesNo [Design Philosophy](https://docs.valyu.ai/concepts/design-philosophy) [API Migrations](https://docs.valyu.ai/api-migration) ⌘I --- # Local MCP | Valyu [Skip to main content](https://docs.valyu.ai/integrations/mcp-desktop#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Agents & MCP Local MCP [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) On this page * [Overview](https://docs.valyu.ai/integrations/mcp-desktop#overview) * [Prerequisites](https://docs.valyu.ai/integrations/mcp-desktop#prerequisites) * [Quick Start](https://docs.valyu.ai/integrations/mcp-desktop#quick-start) * [1\. Clone and Setup](https://docs.valyu.ai/integrations/mcp-desktop#1-clone-and-setup) * [2\. Configure Environment](https://docs.valyu.ai/integrations/mcp-desktop#2-configure-environment) * [3\. Set Up Claude Configuration](https://docs.valyu.ai/integrations/mcp-desktop#3-set-up-claude-configuration) * [Testing Your Setup](https://docs.valyu.ai/integrations/mcp-desktop#testing-your-setup) * [Monitoring Logs](https://docs.valyu.ai/integrations/mcp-desktop#monitoring-logs) * [Troubleshooting](https://docs.valyu.ai/integrations/mcp-desktop#troubleshooting) * [Additional Resources](https://docs.valyu.ai/integrations/mcp-desktop#additional-resources) * [Contributing](https://docs.valyu.ai/integrations/mcp-desktop#contributing) * [License](https://docs.valyu.ai/integrations/mcp-desktop#license) Get **$10 free credits** for the Valyu API when you sign up at [Valyu](https://platform.valyu.ai/) ! [​](https://docs.valyu.ai/integrations/mcp-desktop#overview) Overview ------------------------------------------------------------------------ The Valyu MCP Server is a Model Context Protocol (MCP) tool that enables AI models to retrieve high-quality context from Valyu’s API. It provides comprehensive search capabilities across: * Proprietary data sources * Wikipedia * arXiv * PubMed * Financial data * Web search [​](https://docs.valyu.ai/integrations/mcp-desktop#prerequisites) Prerequisites ---------------------------------------------------------------------------------- Before you begin, ensure you have: * Python 3.10 or higher - Claude Desktop (latest version) - [Valyu API Key](https://platform.valyu.ai/) Verify your Python version: Copy python --version [​](https://docs.valyu.ai/integrations/mcp-desktop#quick-start) Quick Start ------------------------------------------------------------------------------ ### [​](https://docs.valyu.ai/integrations/mcp-desktop#1-clone-and-setup) 1\. Clone and Setup First, clone the repository and set up your environment: Copy git clone https://github.com/valyu-network/valyu-mcp.git cd valyu-mcp Create and activate a virtual environment: Copy bash macOS/Linux python -m venv .venv source .venv/bin/activate bash Windows python -m venv .venv .venv\Scripts\activate Install dependencies: Copy pip install -r requirements.txt ### [​](https://docs.valyu.ai/integrations/mcp-desktop#2-configure-environment) 2\. Configure Environment Create a `.env` file with your API key: Copy echo "VALYU_API_KEY=your-api-key-here" > .env ### [​](https://docs.valyu.ai/integrations/mcp-desktop#3-set-up-claude-configuration) 3\. Set Up Claude Configuration * macOS * Windows Open the config file: `bash code ~/Library/Application\ Support/Claude/claude_desktop_config.json` Open the config file: `powershell code %APPDATA%\Claude\claude_desktop_config.json` Add the Valyu MCP server configuration: Copy { "mcpServers": { "valyu-mcp": { "command": "/ABSOLUTE/PATH/TO/.venv/bin/python", "args": ["-u", "/ABSOLUTE/PATH/TO/valyu-mcp.py"], "env": { "VALYU_API_KEY": "your-api-key-here" } } } } Replace the paths with absolute paths to your Python virtual environment and the script location. [​](https://docs.valyu.ai/integrations/mcp-desktop#testing-your-setup) Testing Your Setup -------------------------------------------------------------------------------------------- Once Claude Desktop restarts, you can confirm if your server is working properly: 1. **Look for the Tools Icon** A hammer icon (tools) should appear in the Claude Desktop interface when your MCP server is running successfully. 2. **Inspect Available Tools** Click the hammer icon to see the list of available tools. You should see `valyu-mcp` listed among the tools. ![Valyu MCP Tools Interface](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/images/valyu-mcp-tools.png?w=2500&fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=abdf7c2366cd5b7fe1aa006f6cbcde01) 3. **Try Example Queries** Test the MCP server with queries that would benefit from Valyu’s context retrieval. For example: > “What are the latest advancements in topological quantum computing” “Find recent research papers about agentic retrievel-augmented generation.” “Explain the concept of volatility clustering in financial markets.” Claude will indicate it’s “Making a tool request: valyu-mcp” and then fetch context from the Valyu API. ![Example of Valyu MCP Response](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/images/valyu-mcp-response.png?w=2500&fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=056bf75f3b3759c0af8df0d6f7614631) ### [​](https://docs.valyu.ai/integrations/mcp-desktop#monitoring-logs) Monitoring Logs For debugging or troubleshooting, you can view the server logs: * macOS * Windows `bash tail -n 20 -F ~/Library/Logs/Claude/mcp*.log` Get-Content $env:APPDATA\\Claude\\Logs\\mcp\_valyu-mcp.log -Wait You can also access logs through **Claude Desktop → Settings → Developer → Open Logs Folder**. Failed MCP servers will have dedicated log files with complete error traces. [​](https://docs.valyu.ai/integrations/mcp-desktop#troubleshooting) Troubleshooting -------------------------------------------------------------------------------------- Common Issues ### [​](https://docs.valyu.ai/integrations/mcp-desktop#modulenotfounderror) ModuleNotFoundError Ensure your virtual environment is activated before running the script. ### [​](https://docs.valyu.ai/integrations/mcp-desktop#server-won%E2%80%99t-start) Server Won’t Start Double-check the paths in `claude_desktop_config.json` are absolute and correct. ### [​](https://docs.valyu.ai/integrations/mcp-desktop#no-results-from-api) No Results from API Verify your API key is valid and has available credits. [​](https://docs.valyu.ai/integrations/mcp-desktop#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------ [Valyu Platform\ --------------\ \ Get your API key and free credits](https://platform.valyu.ai/) [Documentation\ -------------\ \ Explore the full Valyu API documentation](https://docs.valyu.ai/) [Blog\ ----\ \ Read about our latest updates](https://valyu.ai/blog) [GitHub\ ------\ \ View source code and contribute](https://github.com/valyu-network/valyu-mcp) [​](https://docs.valyu.ai/integrations/mcp-desktop#contributing) Contributing -------------------------------------------------------------------------------- We welcome contributions! Feel free to: * Open issues for bug reports * Submit feature requests * Create pull requests [​](https://docs.valyu.ai/integrations/mcp-desktop#license) License ---------------------------------------------------------------------- This project is licensed under the MIT License. * * * Visit [valyu.ai](https://www.valyu.ai/) to learn more about what we’re building at Valyu. Was this page helpful? YesNo [Remote MCP](https://docs.valyu.ai/integrations/mcp-server) [Claude Code Plugin](https://docs.valyu.ai/integrations/claude-code-plugin) ⌘I --- # n8n Integration | Valyu [Skip to main content](https://docs.valyu.ai/integrations/n8n#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Automation Platforms n8n Integration [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) On this page * [What is n8n?](https://docs.valyu.ai/integrations/n8n#what-is-n8n) * [What Can You Do with the Valyu Node?](https://docs.valyu.ai/integrations/n8n#what-can-you-do-with-the-valyu-node) * [Getting Started](https://docs.valyu.ai/integrations/n8n#getting-started) * [Step 1: Get Your Valyu API Key](https://docs.valyu.ai/integrations/n8n#step-1%3A-get-your-valyu-api-key) * [Step 2: Install the Valyu Node in n8n](https://docs.valyu.ai/integrations/n8n#step-2%3A-install-the-valyu-node-in-n8n) * [Step 3: Set Up Your Credentials](https://docs.valyu.ai/integrations/n8n#step-3%3A-set-up-your-credentials) * [Using the Valyu Node](https://docs.valyu.ai/integrations/n8n#using-the-valyu-node) * [Search](https://docs.valyu.ai/integrations/n8n#search) * [Extraction](https://docs.valyu.ai/integrations/n8n#extraction) * [Answer](https://docs.valyu.ai/integrations/n8n#answer) * [Deep Research](https://docs.valyu.ai/integrations/n8n#deep-research) * [Example Workflows](https://docs.valyu.ai/integrations/n8n#example-workflows) * [Automated News Digest](https://docs.valyu.ai/integrations/n8n#automated-news-digest) * [Website Content Monitor](https://docs.valyu.ai/integrations/n8n#website-content-monitor) * [Research Assistant](https://docs.valyu.ai/integrations/n8n#research-assistant) * [Troubleshooting](https://docs.valyu.ai/integrations/n8n#troubleshooting) * [Resources](https://docs.valyu.ai/integrations/n8n#resources) [​](https://docs.valyu.ai/integrations/n8n#what-is-n8n) What is n8n? ----------------------------------------------------------------------- [n8n](https://n8n.io/) is a popular workflow automation tool that lets you connect different apps and services together without writing code. Think of it like connecting building blocks - you can create automated workflows that do things like: * Automatically research topics and save results to a spreadsheet * Extract content from websites and send summaries to Slack * Answer questions using AI and store the responses in a database The Valyu n8n node brings our powerful AI search and research capabilities directly into your n8n workflows. [​](https://docs.valyu.ai/integrations/n8n#what-can-you-do-with-the-valyu-node) What Can You Do with the Valyu Node? ----------------------------------------------------------------------------------------------------------------------- The Valyu node gives you access to four powerful tools: Search ------ Search across the web and premium data sources (academic papers, financial data, news) to find relevant information for any query.**Best for:** Finding information, research, fact-checking Extraction ---------- Pull clean, readable content from any webpage. Optionally use AI to summarize or extract specific data points.**Best for:** Scraping websites, getting article content, data extraction Answer ------ Get instant AI-powered answers to questions, backed by real search results. Fast and accurate.**Best for:** Quick Q&A, chatbots, automated responses Deep Research ------------- Run comprehensive research tasks that search multiple sources and generate detailed reports. Takes 5-30 minutes but produces thorough results.**Best for:** Market research, competitive analysis, in-depth reports [​](https://docs.valyu.ai/integrations/n8n#getting-started) Getting Started ------------------------------------------------------------------------------ ### [​](https://docs.valyu.ai/integrations/n8n#step-1:-get-your-valyu-api-key) Step 1: Get Your Valyu API Key Before you can use the Valyu node, you need an API key: 1. Go to [platform.valyu.ai](https://platform.valyu.ai/) and create a free account 2. Navigate to **API Keys** in the dashboard 3. Click **Create API Key** and copy your new key [Free Credits\ ------------\ \ New accounts get **$10 in free credits** - enough to run thousands of searches!](https://platform.valyu.ai/) ### [​](https://docs.valyu.ai/integrations/n8n#step-2:-install-the-valyu-node-in-n8n) Step 2: Install the Valyu Node in n8n The Valyu node is a community node, which means it’s only available on **self-hosted n8n instances**. It’s not available on n8n Cloud. **To install the node:** 1. In your n8n instance, go to **Settings** (gear icon in the bottom left) 2. Click on **Community Nodes** 3. Click **Install** 4. Enter the package name: `n8n-nodes-valyu` 5. Check the box to accept the risks of installing community nodes 6. Click **Install** That’s it! The Valyu node will now appear when you search for “Valyu” in the nodes panel. ### [​](https://docs.valyu.ai/integrations/n8n#step-3:-set-up-your-credentials) Step 3: Set Up Your Credentials Before using the Valyu node, you need to add your API key: 1. Drag a **Valyu** node onto your canvas 2. Click on the node to open it 3. Next to **Credential to connect with**, click the dropdown and select **Create New Credential** 4. In the popup: * **API Key**: Paste your Valyu API key from Step 1 * **API URL**: Leave as the default (`https://api.valyu.network`) 5. Click **Save** Your credentials are now saved and will be available for all Valyu nodes in your workflows. [​](https://docs.valyu.ai/integrations/n8n#using-the-valyu-node) Using the Valyu Node ---------------------------------------------------------------------------------------- ### [​](https://docs.valyu.ai/integrations/n8n#search) Search Use Search when you need to find information from across the web and premium data sources. **Basic usage:** 1. Select **Search** as the operation 2. Enter your search query (e.g., “latest developments in quantum computing”) 3. Run the node **Optional settings** (click “Add Option” to see these): * **Search Type**: Choose between All, Web only, Proprietary (academic/financial), or News * **Max Results**: How many results to return (1-100) * **Response Length**: How much content per result (Short, Medium, Large, Max) * **Date filters**: Only get results from a specific time period Example: Search for recent AI news Copy Operation: Search Query: "artificial intelligence breakthroughs 2024" Options: - Search Type: News - Max Results: 10 - Start Date: 2024-01-01 ### [​](https://docs.valyu.ai/integrations/n8n#extraction) Extraction Use Extraction when you have specific URLs and want to pull out their content. **Basic usage:** 1. Select **Extraction** as the operation 2. Enter one or more URLs (comma-separated) 3. Choose a **Summary Mode**: * **No AI Processing**: Just get the raw text content * **Auto Summary**: Get an AI-generated summary * **Custom Prompt**: Tell the AI exactly what to extract * **Structured Output**: Extract data into a specific JSON format Example: Extract and summarize an article Copy Operation: Extraction URLs: "https://example.com/article" Summary Mode: Auto Summary Options: - Response Length: Medium ### [​](https://docs.valyu.ai/integrations/n8n#answer) Answer Use Answer when you need a quick, AI-generated response to a question. It automatically searches for relevant information and synthesizes an answer. **Basic usage:** 1. Select **Answer** as the operation 2. Enter your question 3. Choose **Output Type**: * **Text**: Get a plain text answer * **Structured JSON**: Get the answer in a specific format you define Example: Get a quick answer Copy Operation: Answer Question: "What are the main benefits of solar energy?" Output Type: Text Options: - Fast Mode: Yes (for quicker responses) ### [​](https://docs.valyu.ai/integrations/n8n#deep-research) Deep Research Use Deep Research for thorough, comprehensive research that might take several minutes but produces detailed reports. **Basic usage:** 1. Select **Deep Research** as the operation 2. Enter your research query 3. Choose a **Mode**: * **Standard (10-20 min)**: For balanced research questions * **Heavy (15-30 min)**: For complex, multi-faceted topics The node will wait for the research to complete and return the full report.Example: Research a market Copy Operation: Deep Research Research Query: "Analyze the electric vehicle market in Europe, including major players, market share, and growth trends" Mode: Heavy Options: - Output Formats: Markdown, PDF - Strategy: "Focus on data from 2023-2024. Include specific statistics and cite sources." [​](https://docs.valyu.ai/integrations/n8n#example-workflows) Example Workflows ---------------------------------------------------------------------------------- ### [​](https://docs.valyu.ai/integrations/n8n#automated-news-digest) Automated News Digest Create a daily digest of news on topics you care about: 1. **Schedule Trigger** → Runs every morning at 8am 2. **Valyu (Search)** → Search for “AI news” with News search type 3. **Valyu (Answer)** → Summarize the key stories 4. **Send Email** → Email yourself the digest ### [​](https://docs.valyu.ai/integrations/n8n#website-content-monitor) Website Content Monitor Track changes to competitor websites: 1. **Schedule Trigger** → Runs weekly 2. **Valyu (Extraction)** → Extract content from competitor URLs 3. **Compare** → Check against previous extraction 4. **Slack** → Notify if changes detected ### [​](https://docs.valyu.ai/integrations/n8n#research-assistant) Research Assistant Build a research pipeline for market analysis: 1. **Webhook Trigger** → Receive research requests 2. **Valyu (Deep Research)** → Run comprehensive research 3. **Google Sheets** → Save report to a spreadsheet 4. **Slack** → Notify when complete with link to report [​](https://docs.valyu.ai/integrations/n8n#troubleshooting) Troubleshooting ------------------------------------------------------------------------------ Node not appearing after installation Try restarting your n8n instance. If using Docker, restart the container. Authentication errors Double-check your API key is correct. Make sure there are no extra spaces when you paste it. Deep Research timing out Deep Research can take up to 30 minutes for Heavy mode. Make sure your n8n workflow timeout settings allow for long-running operations. Rate limiting If you’re hitting rate limits, add a small delay between Valyu node executions using the Wait node. [​](https://docs.valyu.ai/integrations/n8n#resources) Resources ------------------------------------------------------------------ [npm Package\ -----------\ \ View the package on npm](https://www.npmjs.com/package/n8n-nodes-valyu) [GitHub Repository\ -----------------\ \ Source code and issues](https://github.com/valyu-network/n8n-nodes-valyu) [n8n Community Nodes Docs\ ------------------------\ \ Official n8n documentation on installing community nodes](https://docs.n8n.io/integrations/community-nodes/installation/) [Valyu Discord\ -------------\ \ Get help from the community](https://discord.gg/umtmSsppRY) Was this page helpful? YesNo [AWS Bedrock AgentCore](https://docs.valyu.ai/integrations/aws-agentcore) [Vercel AI SDK](https://docs.valyu.ai/integrations/vercel-ai-sdk) ⌘I --- # Page Not Found [Skip to main content](https://docs.valyu.ai/integrations/ai-sdk#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Page Not Found [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [Claude Agent SDK Integration](https://docs.valyu.ai/integrations/claude-agent-sdk#) [Vercel AI SDK](https://docs.valyu.ai/integrations/vercel-ai-sdk#) [Welcome to Valyu](https://docs.valyu.ai/overview#integrations) ⌘I --- # Page Not Found [Skip to main content](https://docs.valyu.ai/integrations/mcp#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Page Not Found [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [Welcome to Valyu](https://docs.valyu.ai/overview#integrations) [Remote MCP](https://docs.valyu.ai/integrations/mcp-server#) [Claude Agent SDK Integration](https://docs.valyu.ai/integrations/claude-agent-sdk#overview) ⌘I --- # Page Not Found [Skip to main content](https://docs.valyu.ai/guides/deep-research/batch-quickstart#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Page Not Found [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [Batch Processing Quickstart](https://docs.valyu.ai/guides/deepresearch-batch-quickstart#batch-processing-quickstart) [DeepResearch Quickstart](https://docs.valyu.ai/guides/deepresearch-quickstart#deepresearch-quickstart) [DeepResearch Batch API](https://docs.valyu.ai/sdk/python-sdk/deepresearch-batch#deepresearch-batch-api) ⌘I --- # Page Not Found [Skip to main content](https://docs.valyu.ai/integrations/community/claude-agent-sdk#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Page Not Found [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [Claude Agent SDK Integration](https://docs.valyu.ai/integrations/claude-agent-sdk#) [Changelog](https://docs.valyu.ai/changelog/sdk-and-api#january-02-2026) [Anthropic Integration](https://docs.valyu.ai/integrations/anthropic#) ⌘I --- # Page Not Found [Skip to main content](https://docs.valyu.ai/changelog/guides/ai-sdk-paper-search#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Page Not Found [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [Changelog](https://docs.valyu.ai/changelog/sdk-and-api#) [Build a Financial Analysis AI Agent](https://docs.valyu.ai/guides/ai-sdk-financial-search#build-a-financial-analysis-ai-agent) [Build a Patent Discovery AI Agent](https://docs.valyu.ai/guides/ai-sdk-patent-search#build-a-patent-discovery-ai-agent) ⌘I --- # Page Not Found [Skip to main content](https://docs.valyu.ai/changelog/guides/badge#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Page Not Found [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [Changelog](https://docs.valyu.ai/changelog/platform#) [Powered by Valyu Badge](https://docs.valyu.ai/guides/badge#) [Prompting Guide](https://docs.valyu.ai/search/prompting#) ⌘I --- # Page Not Found [Skip to main content](https://docs.valyu.ai/api-reference/endpoint/deepsearch#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Page Not Found [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [DeepResearch API](https://docs.valyu.ai/sdk/typescript-sdk/deepresearch#deepresearch-api) [DeepResearch Batch API](https://docs.valyu.ai/sdk/python-sdk/deepresearch-batch#deepresearch-batch-api) [API Migrations](https://docs.valyu.ai/api-migration#search-endpoint-migration) ⌘I --- # Page Not Found [Skip to main content](https://docs.valyu.ai/api-reference/deepsearch#content-area) [Valyu home page![light logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=8a74b9f94db6df41a02cb6b8c2500fea)![dark logo](https://mintcdn.com/valyu/ji-tdRNtRRe7QxMv/logo/valyu-logo-dark.png?fit=max&auto=format&n=ji-tdRNtRRe7QxMv&q=85&s=e49a3dc6601a4b0aaf3ca1582a3a011e)](https://docs.valyu.ai/) Search... ⌘K Search... Navigation Page Not Found [Home](https://docs.valyu.ai/home) [Documentation](https://docs.valyu.ai/overview) [API Reference](https://docs.valyu.ai/api-reference/endpoint/search) [SDKs](https://docs.valyu.ai/sdk/python-sdk) [Integrations](https://docs.valyu.ai/integrations/mcp-server) [Changelog](https://docs.valyu.ai/changelog/platform) 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [DeepResearch API](https://docs.valyu.ai/sdk/typescript-sdk/deepresearch#deepresearch-api) [DeepResearch Batch API](https://docs.valyu.ai/sdk/python-sdk/deepresearch-batch#deepresearch-batch-api) ⌘I ---