Web Search
Search public web content with Tavily.
Tavily Search
Search the web and return ranked results with titles, URLs and content snippets. query is required. Use max_results to control the number of results and search_depth to select the search mode. Additional answer, images and raw content are returned only when requested. Set include_usage to receive resource usage information; usage.credits is not a Felo charge.
- 类型: stringquery必填
The search query to execute with Tavily.
- 类型: booleanauto
_parameters Automatically configure search parameters based on query content.
- 类型: integerchunks
_per _source 最小值:1最大值:3Maximum number of relevant chunks returned per source.
- 类型: string 枚举country
Boost search results from a specific country. Available only when topic is general.
值- afghanistan
- albania
- algeria
- andorra
- angola
- 类型: string 格式: dateend
_date Return results before the specified end date.
- 类型: array string[] …150exclude
_domains List of domains to specifically exclude from the search results.
- include
_answer Include an LLM-generated answer. true uses the default answer mode; basic or advanced selects the answer generation mode.
- 类型: boolean
Include an LLM-generated answer. true uses the default answer mode; basic or advanced selects the answer generation mode.
- 类型: array string[] …300include
_domains List of domains to specifically include in the search results.
- 类型: booleaninclude
_favicon Include the favicon URL for each result.
- 类型: booleaninclude
_image _descriptions Add descriptive text for each image when include_images is true.
- 类型: booleaninclude
_images Perform an image search and include results.
- include
_raw _content Include cleaned and parsed content for each search result. true or markdown returns markdown; text returns plain text and may increase latency.
- 类型: boolean
Include cleaned and parsed content for each search result. true or markdown returns markdown; text returns plain text and may increase latency.
- 类型: booleaninclude
_usage Include resource usage information in the response. This is not Felo billing information.
- 类型: integermax
_results 最小值:0最大值:20Maximum number of search results to return.
- 类型: booleansafe
_search Filter out adult or unsafe content from search results. Enterprise only; not supported when search_depth is fast or ultra-fast.
- 类型: string 枚举search
_depth Controls the latency vs. relevance tradeoff. advanced gives the highest relevance with higher latency and cost; basic is balanced; fast and ultra-fast optimize for lower latency.
值- advanced
- basic
- fast
- ultra
-fast
- 类型: string 格式: datestart
_date Return results after the specified start date.
- 类型: string 枚举time
_range Time range to filter results based on publish date.
值- day
- week
- month
- year
- d
- w
- m
- y
- 类型: string 枚举topic
Category of the search.
值- general
- news
- finance
- 类型: object200
Search results returned successfully.
- 类型: string 可为 nullanswer
A short LLM-generated answer. Present as null when include_answer is false or no answer is generated.
- 类型: array object[]images
- description类型: string
Image description.
- url类型: string
Image URL.
- 类型: stringquery
The search query that was executed.
- 类型: stringrequest
_id Unique request identifier.
- 类型: number 格式: floatresponse
_time Time in seconds it took to complete the request.
- 类型: array object[]results
- content类型: string
Content snippet of the search result.
- favicon类型: string 可为 null
Favicon URL of the search result.
- raw类型: string 可为 null
_content Cleaned and parsed source content. Null unless include_raw_content is requested or no raw content is available.
- score类型: number 格式: float
Relevance score of the search result.
- title类型: string
Title of the search result.
- url类型: string
URL of the search result.
- 类型: objectusage
- credits类型: integer
Resource units consumed by this request, not USD or Felo credits.
application/json - 400
The request could not be processed. Check the request parameters.
- 401
A valid Felo API key is required.
- 402
The request cannot proceed because a billing requirement is not met.
- 403
The account is not permitted to perform this operation.
- 429
A request or spending limit has been reached.
- 502
The service could not complete the request.
- 503
The API or billing service is temporarily unavailable.
- 504
The service timed out while processing the request.
- default
The operation failed. Keep the response request ID when contacting Felo support.
curl --request POST https://openapi.felo.ai/v1/beta/tavily/search \
--header "Authorization: Bearer ${FELO_API_KEY:?Set FELO_API_KEY}" \
--header 'Content-Type: application/json' \
--data '{"query": "Python official documentation", "search_depth": "basic", "max_results": 2, "include_usage": true}'
{
"query": "Python official documentation",
"answer": null,
"images": [],
"results": [
{
"title": "Python Documentation",
"url": "https://docs.python.org/3/",
"content": "Documentation for the Python programming language.",
"score": 0.98,
"raw_content": null
}
],
"response_time": 1.2,
"usage": {
"credits": 1
},
"request_id": "example-search-request"
}