> ## Documentation Index
> Fetch the complete documentation index at: https://agno-v2.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Jina Reader

> JinaReaderTools calls the Jina Reader API to expose read_url and search_query functions that fetch and search web content.

**JinaReaderTools** enable an Agent to read web pages and perform searches using the Jina Reader API.

## Prerequisites

The toolkit calls the Jina Reader API over HTTP and needs no additional library. The example below uses the default OpenAI model:

```shell theme={null}
uv pip install -U openai
```

If `api_key` is not passed, the toolkit reads the `JINA_API_KEY` environment variable.

```shell theme={null}
export JINA_API_KEY=***
```

## Example

The following agent will use the Jina Reader API to summarize the content of [https://github.com/agno-agi/agno](https://github.com/agno-agi/agno)

```python cookbook/91_tools/jinareader_tools.py theme={null}
from agno.agent import Agent
from agno.tools.jina import JinaReaderTools

agent = Agent(tools=[JinaReaderTools()])
agent.print_response("Summarize: https://github.com/agno-agi/agno")
```

## Toolkit Params

| Parameter | Type | Default | Description |
| - | - | - | - |
| `api_key` | `Optional[str]` | `None` | The API key for authentication purposes. If not provided, uses JINA\_API\_KEY environment variable. |
| `base_url` | `str` | `"https://r.jina.ai/"` | The base URL of the API. |
| `search_url` | `str` | `"https://s.jina.ai/"` | The URL used for search queries. |
| `max_content_length` | `int` | `10000` | The maximum length of content allowed. |
| `timeout` | `Optional[int]` | `None` | Timeout in seconds for API requests. |
| `search_query_content` | `bool` | `True` | Include content in search query results. |
| `enable_read_url` | `bool` | `True` | Enable the read\_url functionality. |
| `enable_search_query` | `bool` | `False` | Enable the search\_query functionality. |
| `all` | `bool` | `False` | Enable all functionality. |

## Toolkit Functions

| Function | Description |
| - | - |
| `read_url` | Reads the content of a specified URL using Jina Reader API. Parameters include `url` for the URL to read. Returns the truncated content or an error message if the request fails. |
| `search_query` | Performs a web search using Jina Reader API based on a specified query. Parameters include `query` for the search term. Returns the truncated search results or an error message if the request fails. |

## Developer Resources

* [Tools](https://github.com/agno-agi/agno/blob/main/libs/agno/agno/tools/jina.py)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.