Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Tavily Search

Felo API Support
MIT
Server:https://openapi.felo.ai
Client Libraries
Shell Curl

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.

Body
required
application/json
  • query
    Type: string
    required

    The search query to execute with Tavily.

  • auto_parameters
    Type: boolean

    Automatically configure search parameters based on query content.

  • chunks_per_source
    Type: integer
    min:  
    1
    max:  
    3

    Maximum number of relevant chunks returned per source.

  • country
    Type: string enum

    Boost search results from a specific country. Available only when topic is general.

    values
    • afghanistan
    • albania
    • algeria
    • andorra
    • angola
  • end_date
    Type: string Format: date

    Return results before the specified end date.

  • exclude_domains
    Type: array string[] …150

    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.

    • Type: boolean

      Include an LLM-generated answer. true uses the default answer mode; basic or advanced selects the answer generation mode.

  • include_domains
    Type: array string[] …300

    List of domains to specifically include in the search results.

  • include_favicon
    Type: boolean

    Include the favicon URL for each result.

  • include_image_descriptions
    Type: boolean

    Add descriptive text for each image when include_images is true.

  • include_images
    Type: boolean

    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.

    • Type: boolean

      Include cleaned and parsed content for each search result. true or markdown returns markdown; text returns plain text and may increase latency.

  • include_usage
    Type: boolean

    Include resource usage information in the response. This is not Felo billing information.

  • max_results
    Type: integer
    min:  
    0
    max:  
    20

    Maximum number of search results to return.

  • Type: boolean

    Filter out adult or unsafe content from search results. Enterprise only; not supported when search_depth is fast or ultra-fast.

  • search_depth
    Type: string enum

    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.

    values
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    Type: string Format: date

    Return results after the specified start date.

  • time_range
    Type: string enum

    Time range to filter results based on publish date.

    values
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    Type: string enum

    Category of the search.

    values
    • general
    • news
    • finance
Responses
  • 200
    Type: object

    Search results returned successfully.

    • answer
      Type: string nullable

      A short LLM-generated answer. Present as null when include_answer is false or no answer is generated.

    • images
      Type: array object[]
      • description
        Type: string

        Image description.

      • url
        Type: string

        Image URL.

    • query
      Type: string

      The search query that was executed.

    • request_id
      Type: string

      Unique request identifier.

    • response_time
      Type: number Format: float

      Time in seconds it took to complete the request.

    • results
      Type: array object[]
      • content
        Type: string

        Content snippet of the search result.

      • favicon
        Type: string nullable

        Favicon URL of the search result.

      • raw_content
        Type: string nullable

        Cleaned and parsed source content. Null unless include_raw_content is requested or no raw content is available.

      • score
        Type: number Format: float

        Relevance score of the search result.

      • title
        Type: string

        Title of the search result.

      • url
        Type: string

        URL of the search result.

    • usage
      Type: object
      • credits
        Type: 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.

Request Example for post/v1/beta/tavily/search
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"
}

Search results returned successfully.

Tavily Search