> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Tavily

> Reference for the Tracecat Tavily integration: registered actions, required secrets, expected inputs, and example workflow usage.

## Search the web

Action ID: `tools.tavily.web_search`

Search the web with Tavily for a given search query.

Reference: [https://docs.tavily.com/documentation/api-reference/endpoint/search](https://docs.tavily.com/documentation/api-reference/endpoint/search)

### Secrets

Required secrets:

* `tavily`: required values `TAVILY_API_KEY`.

### Input fields

<ParamField path="query" type="string" required>
  Search query to execute with Tavily.
</ParamField>

<ParamField path="search_deep" type="string" required>
  Depth of the search.

  Allowed values: `basic`, `advanced`.
</ParamField>

<ParamField path="time_range" type="string" required>
  Time range back from the current date to filter results.

  Allowed values: `day`, `week`, `month`, `year`.
</ParamField>

<ParamField path="topic" type="string" required>
  Category of the search.

  Allowed values: `general`, `news`.
</ParamField>
