Felo API PlatformFelo API Platform
Todos os endpoints de Tavily
v0.2.0-beta
OpenAPI 3.1.0

Tavily Search

Servidor:https://openapi.felo.ai
Bibliotecas Cliente

Tavily Search

​

Pesquisa na web e retorna resultados classificados com títulos, URLs e trechos de conteúdo. query é obrigatório. Use max_results para controlar o número de resultados e search_depth para selecionar o modo de pesquisa. answer, images e raw content adicionais só são retornados quando solicitados. Defina include_usage para receber informações de uso de recursos; usage.credits não é uma cobrança da Felo.

Referência de preços

  • Medição: unidades de resposta medidas.
  • Estimativa de referência por requisição: USD 0.016.
  • Base de custo unitário: USD 0.008.
  • Unidade de recurso: tavily_credit.
  • Multiplicador de referência do cliente: 1.0. Não o aplique novamente a um valor de cliente já liquidado.
  • As bases de custo não definem o preço final do cliente, inclusive quando forem zero.

Apenas metadados de referência, não uma cotação da conta, um preço garantido ou um limite de gastos. Créditos de recursos não são créditos Felo. As cobranças finais seguem os registros de cobrança da Felo.

Corpo
obrigatório
application/json
  • query
    Tipo: string
    obrigatório

    A consulta de pesquisa a executar com o Tavily.

  • auto_parameters
    Tipo: boolean

    Configura automaticamente os parâmetros de pesquisa com base no conteúdo da query.

  • chunks_per_source
    Tipo: integer
    mín:  
    1
    máx:  
    3

    Número máximo de trechos relevantes retornados por fonte.

  • country
    Tipo: string enum

    Aumenta a relevância de resultados de pesquisa de um país específico. Disponível apenas quando topic é general.

    valores
    • afghanistan
    • albania
    • algeria
    • andorra
    • angola
  • end_date
    Tipo: string Formato: date

    Retorna resultados anteriores à data de término especificada.

  • exclude_domains
    Tipo: array string[] …150

    Lista de domínios a excluir especificamente dos resultados de pesquisa.

  • include_answer

    Inclui uma resposta gerada por LLM. true usa o modo de resposta padrão; basic ou advanced seleciona o modo de geração de resposta.

    • Tipo: boolean

      Inclui uma resposta gerada por LLM. true usa o modo de resposta padrão; basic ou advanced seleciona o modo de geração de resposta.

  • include_domains
    Tipo: array string[] …300

    Lista de domínios a incluir especificamente nos resultados de pesquisa.

  • include_favicon
    Tipo: boolean

    Inclui a URL do favicon de cada resultado.

  • include_image_descriptions
    Tipo: boolean

    Adiciona texto descritivo para cada imagem quando include_images é true.

  • include_images
    Tipo: boolean

    Realiza uma pesquisa de imagens e inclui os resultados.

  • include_raw_content

    Inclui conteúdo limpo e analisado para cada resultado de pesquisa. true ou markdown retorna markdown; text retorna texto simples e pode aumentar a latência.

    • Tipo: boolean

      Inclui conteúdo limpo e analisado para cada resultado de pesquisa. true ou markdown retorna markdown; text retorna texto simples e pode aumentar a latência.

  • include_usage
    Tipo: boolean

    Inclui informações de uso de recursos na resposta. Não são informações de cobrança da Felo.

  • max_results
    Tipo: integer
    mín:  
    0
    máx:  
    20

    Número máximo de resultados de pesquisa a retornar.

  • Tipo: boolean

    Filtra conteúdo adulto ou inseguro dos resultados de pesquisa. Somente Enterprise; não suportado quando search_depth é fast ou ultra-fast.

  • search_depth
    Tipo: string enum

    Controla o equilíbrio entre latência e relevância. advanced oferece a maior relevância, com maior latência e custo; basic é equilibrado; fast e ultra-fast otimizam para menor latência.

    valores
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    Tipo: string Formato: date

    Retorna resultados posteriores à data de início especificada.

  • time_range
    Tipo: string enum

    Intervalo de tempo para filtrar resultados com base na data de publicação.

    valores
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    Tipo: string enum

    Categoria da pesquisa.

    valores
    • general
    • news
    • finance
Respostas
  • 200
    Tipo: object

    Resultados de pesquisa retornados com sucesso.

    • answer
      Tipo: string | null

      Uma resposta curta gerada por LLM. Presente como null quando include_answer é false ou nenhuma resposta é gerada.

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

        Descrição da imagem.

      • url
        Tipo: string

        URL da imagem.

    • query
      Tipo: string

      A consulta de pesquisa executada.

    • request_id
      Tipo: string

      Identificador exclusivo da requisição.

    • response_time
      Tipo: number Formato: float

      Tempo em segundos para concluir a requisição.

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

        Trecho de conteúdo do resultado de pesquisa.

      • favicon
        Tipo: string | null

        URL do favicon do resultado de pesquisa.

      • raw_content
        Tipo: string | null

        Conteúdo de origem limpo e analisado. Null, a menos que include_raw_content seja solicitado ou que nenhum conteúdo bruto esteja disponível.

      • score
        Tipo: number Formato: float

        Pontuação de relevância do resultado de pesquisa.

      • title
        Tipo: string

        Título do resultado de pesquisa.

      • url
        Tipo: string

        URL do resultado de pesquisa.

    • usage
      Tipo: object
      • credits
        Tipo: integer

        Unidades de recursos consumidas por esta requisição, não USD nem créditos Felo.

    application/json
  • 400

    Não foi possível processar a requisição. Verifique os parâmetros da requisição.

  • 401

    É necessária uma chave de API da Felo válida.

  • 402

    A requisição não pode prosseguir porque um requisito de cobrança não foi atendido.

  • 403

    A conta não tem permissão para realizar esta operação.

  • 429

    Um limite de requisições ou de gastos foi atingido.

  • 502

    O serviço não pôde concluir a requisição.

  • 503

    A API ou o serviço de cobrança está temporariamente indisponível.

  • 504

    O serviço atingiu o tempo limite ao processar a requisição.

  • default

    Resposta de erro; respostas repassadas do upstream podem usar formatos do provedor

    application/json
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"
}
Tavily Search