diff --git a/README.md b/README.md index 81aaaee..897a2a6 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![Python](https://img.shields.io/badge/python-3.10%20%E2%80%93%203.13-green) ![License](https://img.shields.io/badge/license-MIT-blue) -[CrewAI](https://www.crewai.com) tools for the [Decodo](https://decodo.com) Web Scraping API. Give your agents live web pages and search results. +[Decodo Web Data API](https://help.decodo.com/docs/web-data-api-introduction) tools for [CrewAI](https://www.crewai.com). Give your agents live web pages and search results. | Tool | What it does | | --- | --- | @@ -15,7 +15,7 @@ ## Requirements - Python 3.10 to 3.13 -- A Decodo Web Scraping API key +- A Decodo Web Data API key. Basic authentication tokens from older plans don't work with these tools. ## Installation @@ -25,7 +25,7 @@ pip install decodo-crewai ## Credentials -Copy your API key from your Web Scraping API subscription on the [Decodo dashboard](https://dashboard.decodo.com/web-data/playground) and set it as an environment variable: +Copy your API key from your Web Data API subscription on the [Decodo dashboard](https://dashboard.decodo.com/web-data/playground) and set it as an environment variable: ```bash export DECODO_API_KEY="" @@ -88,7 +88,7 @@ Constructor options: | Option | Default | Description | | --- | --- | --- | -| `api_key` | `DECODO_API_KEY` | Decodo Web Scraping API key. | +| `api_key` | `DECODO_API_KEY` | Decodo Web Data API key. | | `max_chars` | `45000` | Markdown longer than this is truncated to keep the page within the agent's context. | ### DecodoSearchTool @@ -112,6 +112,8 @@ Arguments the agent fills in. Pass either `product_id` or `query`: | `query` | `str`, optional | Search the store's products instead. | | `zip_code` | `str`, optional | US ZIP code for prices and availability at that delivery location, e.g. `10001`. | +Target pages are rendered in a headless browser and can take close to a minute. + ### DecodoSERPTool Arguments the agent fills in: diff --git a/examples/research_crew/README.md b/examples/research_crew/README.md index 84780bc..26df95a 100644 --- a/examples/research_crew/README.md +++ b/examples/research_crew/README.md @@ -27,7 +27,7 @@ DECODO_API_KEY= OPENAI_API_KEY= ``` -Get the Decodo API key from your Web Scraping API subscription on the [Decodo dashboard](https://dashboard.decodo.com/web-data/playground). +Get the Decodo API key from your Web Data API subscription on the [Decodo dashboard](https://dashboard.decodo.com/web-data/playground). The crew uses CrewAI's default model, `gpt-4.1-mini`. To use another model, set `MODEL`, e.g. `MODEL=gpt-4.1`. Other providers need their CrewAI extra and key, e.g. `pip install "crewai[anthropic]"`, `ANTHROPIC_API_KEY` and `MODEL=anthropic/`. diff --git a/pyproject.toml b/pyproject.toml index ac2ecc9..ef40e34 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "hatchling.build" [project] name = "decodo-crewai" version = "0.0.0" -description = "Decodo Web Scraping API tools for CrewAI agents." +description = "Decodo Web Data API tools for CrewAI agents." readme = "README.md" license = { file = "LICENSE" } requires-python = ">=3.10,<3.14" diff --git a/src/decodo_crewai/_base.py b/src/decodo_crewai/_base.py index e41d294..ee421cc 100644 --- a/src/decodo_crewai/_base.py +++ b/src/decodo_crewai/_base.py @@ -26,7 +26,7 @@ class DecodoBaseTool(BaseTool): """Shared Decodo client and error handling for the Decodo tools. - Get an API key from your Web Scraping API subscription on the Decodo dashboard: + Get an API key from your Web Data API subscription on the Decodo dashboard: https://dashboard.decodo.com/web-data/playground """ @@ -35,7 +35,7 @@ class DecodoBaseTool(BaseTool): default_factory=lambda: [ EnvVar( name=API_KEY_ENV_VAR, - description="API key for the Decodo Web Scraping API", + description="API key for the Decodo Web Data API", required=True, ) ] diff --git a/src/decodo_crewai/ecommerce_tool.py b/src/decodo_crewai/ecommerce_tool.py index 4f455c5..75744dd 100644 --- a/src/decodo_crewai/ecommerce_tool.py +++ b/src/decodo_crewai/ecommerce_tool.py @@ -46,7 +46,7 @@ class DecodoEcommerceTool(DecodoBaseTool): """Get product details or search results from Amazon, Walmart or Target, parsed as JSON. Args: - api_key: Decodo Web Scraping API key. Defaults to the ``DECODO_API_KEY`` environment variable. + api_key: Decodo Web Data API key. Defaults to the ``DECODO_API_KEY`` environment variable. """ name: str = "Decodo Ecommerce" diff --git a/src/decodo_crewai/search_tool.py b/src/decodo_crewai/search_tool.py index bf125fc..cf856c0 100644 --- a/src/decodo_crewai/search_tool.py +++ b/src/decodo_crewai/search_tool.py @@ -26,10 +26,10 @@ class DecodoSearchArgs(BaseModel): class DecodoSearchTool(DecodoBaseTool): - """Search Google or Amazon with the Decodo Web Scraping API and return the parsed results as JSON. + """Search Google or Amazon with the Decodo Web Data API and return the parsed results as JSON. Args: - api_key: Decodo Web Scraping API key. Defaults to the ``DECODO_API_KEY`` environment variable. + api_key: Decodo Web Data API key. Defaults to the ``DECODO_API_KEY`` environment variable. """ name: str = "Decodo Search" diff --git a/src/decodo_crewai/serp_tool.py b/src/decodo_crewai/serp_tool.py index 38a806a..a2e5ef4 100644 --- a/src/decodo_crewai/serp_tool.py +++ b/src/decodo_crewai/serp_tool.py @@ -32,7 +32,7 @@ class DecodoSERPTool(DecodoBaseTool): """Search Google or Bing, or ask Google AI Mode, and return the parsed results as JSON. Args: - api_key: Decodo Web Scraping API key. Defaults to the ``DECODO_API_KEY`` environment variable. + api_key: Decodo Web Data API key. Defaults to the ``DECODO_API_KEY`` environment variable. """ name: str = "Decodo SERP" diff --git a/src/decodo_crewai/web_scraper_tool.py b/src/decodo_crewai/web_scraper_tool.py index 823ea58..6f12f76 100644 --- a/src/decodo_crewai/web_scraper_tool.py +++ b/src/decodo_crewai/web_scraper_tool.py @@ -20,10 +20,10 @@ class DecodoWebScraperArgs(BaseModel): class DecodoWebScraperTool(DecodoBaseTool): - """Scrape any public web page with the Decodo Web Scraping API and return it as Markdown. + """Scrape any public web page with the Decodo Web Data API and return it as Markdown. Args: - api_key: Decodo Web Scraping API key. Defaults to the ``DECODO_API_KEY`` environment variable. + api_key: Decodo Web Data API key. Defaults to the ``DECODO_API_KEY`` environment variable. max_chars: Markdown longer than this is truncated, to keep the page within the agent's context. """