mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-06 23:49:24 +00:00
f2960ccaaf
* Add Tavily Research and get Research - Added tavily research with docs to crew AI - Added tavily get research with docs to crew AI * Update `tavily-python` installation instructions and adjust version constraints - Changed installation command from `pip install` to `uv add` for `tavily-python` in multiple documentation files. - Updated version constraint for `tavily-python` in `pyproject.toml` from `>=0.7.14` to `~=0.7.14`. - Modified the `exclude-newer` date in `uv.lock` to `2026-04-23T07:00:00Z`. * Add Tavily Research Tool documentation in multiple languages - Introduced `TavilyResearchTool` documentation in English, Arabic, Korean, and Portuguese. - Updated `docs.json` to include paths for the new documentation files. - The `TavilyResearchTool` allows CrewAI agents to perform multi-step research tasks and generate cited reports using the Tavily Research API. * Fix Tavily research CI failures * added getResearchTool docs - Added docs for getResearchTool --------- Co-authored-by: lorenzejay <lorenzejaytech@gmail.com> Co-authored-by: Evan Rimer <evan.rimer@tavily.com> Co-authored-by: Lorenze Jay <63378463+lorenzejay@users.noreply.github.com>
86 lines
2.9 KiB
Plaintext
86 lines
2.9 KiB
Plaintext
---
|
|
title: "Tavily Get Research Tool"
|
|
description: "Retrieve the status and results of an existing Tavily research task"
|
|
icon: "clipboard-list"
|
|
mode: "wide"
|
|
---
|
|
|
|
The `TavilyGetResearchTool` lets CrewAI agents check an existing Tavily research task by `request_id`. Use it when a research task was started earlier and you need to retrieve its current status or final results.
|
|
|
|
If you need to start a new research job, use the [Tavily Research Tool](/en/tools/search-research/tavilyresearchtool). This tool is specifically for looking up an existing Tavily research request after you already have its `request_id`.
|
|
|
|
## Installation
|
|
|
|
To use the `TavilyGetResearchTool`, install the `tavily-python` library alongside `crewai-tools`:
|
|
|
|
```shell
|
|
uv add 'crewai[tools]' tavily-python
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
Set your Tavily API key:
|
|
|
|
```bash
|
|
export TAVILY_API_KEY='your_tavily_api_key'
|
|
```
|
|
|
|
Get an API key at [https://app.tavily.com/](https://app.tavily.com/) (sign up, then create a key).
|
|
|
|
## Example Usage
|
|
|
|
```python
|
|
from crewai_tools import TavilyGetResearchTool
|
|
|
|
tavily_get_research_tool = TavilyGetResearchTool()
|
|
|
|
status_result = tavily_get_research_tool.run(
|
|
request_id="your-research-request-id"
|
|
)
|
|
|
|
print(status_result)
|
|
```
|
|
|
|
## Common Workflow
|
|
|
|
Use `TavilyGetResearchTool` when your application or another service has already created a Tavily research task and saved its `request_id`.
|
|
|
|
Typical cases include:
|
|
|
|
- Polling for completion after kicking off research in a background job.
|
|
- Looking up the latest status of a long-running research task.
|
|
- Fetching final research output from a previously created Tavily request.
|
|
|
|
## Configuration Options
|
|
|
|
The `TavilyGetResearchTool` accepts the following argument when calling the `run` method:
|
|
|
|
- `request_id` (str): **Required.** The existing Tavily research request ID to retrieve.
|
|
|
|
## Async Usage
|
|
|
|
Use `_arun` when your application is already running inside an async event loop:
|
|
|
|
```python
|
|
from crewai_tools import TavilyGetResearchTool
|
|
|
|
tavily_get_research_tool = TavilyGetResearchTool()
|
|
|
|
status_result = await tavily_get_research_tool._arun(
|
|
request_id="your-research-request-id"
|
|
)
|
|
```
|
|
|
|
## Features
|
|
|
|
- **Research status retrieval**: Fetch the current status of an existing Tavily research task.
|
|
- **Result retrieval**: Return available research output once Tavily has completed the task.
|
|
- **Sync and async**: Use either `_run`/`run` or `_arun` depending on your application's runtime.
|
|
- **JSON output**: Returns Tavily responses as formatted JSON strings.
|
|
|
|
## Response Format
|
|
|
|
The tool returns a JSON string containing the current research task status and any available results from Tavily. The exact response shape depends on the task state returned by Tavily, so incomplete tasks may return status information before the final research output is available.
|
|
|
|
Refer to the [Tavily API documentation](https://docs.tavily.com/) for full details on the Research API.
|