Felo API PlatformFelo API Platform
Все эндпоинты Tavily
v0.2.0-beta
OpenAPI 3.1.0

Tavily Extract

Сервер:https://openapi.felo.ai
Клиентские библиотеки

Web Content

​

Web crawling, URL discovery and page extraction.

Web Content Операции

Tavily Extract

​

Извлекает читаемое содержимое из одного URL или массива URL. Выберите текст или Markdown с помощью format. Проверяйте и results, и failed_results: URL с ошибкой может быть указан в остальном успешном HTTP-ответе. Установите include_usage, чтобы получать сведения об использовании ресурсов; usage.credits — это не списание Felo.

Справочная информация о ценах

  • Тарификация: тарифицируемые единицы ответа.
  • Справочная оценка запроса: USD 0.024.
  • Базовая стоимость единицы: USD 0.008.
  • Единица ресурса: tavily_credit.
  • Справочный множитель для клиента: 1.0. Не применяйте его повторно к уже рассчитанной сумме клиента.
  • Базовые стоимости не определяют итоговую цену для клиента, в том числе когда они равны нулю.

Только справочные метаданные, а не котировка для аккаунта, гарантированная цена или лимит расходов. Кредиты ресурсов — не кредиты Felo. Итоговые списания определяются записями биллинга Felo.

Тело
обязательно
application/json
  • urls
    обязательно

    URL или URL-адреса, из которых нужно извлечь содержимое. Принимается как одна строка URL, так и массив строк URL.

    • Тип: string

      URL или URL-адреса, из которых нужно извлечь содержимое. Принимается как одна строка URL, так и массив строк URL.

  • chunks_per_source
    Тип: integer
    мин.:  
    1
    макс.:  
    5

    Максимальное количество релевантных чанков, возвращаемых на источник. Доступно только при указании query.

  • extract_depth
    Тип: string enum

    Глубина процесса извлечения.

    значения
    • basic
    • advanced
  • format
    Тип: string enum

    Формат извлечённого содержимого веб-страницы.

    значения
    • markdown
    • text
  • include_favicon
    Тип: boolean

    Включать URL favicon для каждого результата.

  • include_images
    Тип: boolean

    Включать список изображений, извлечённых из URL.

  • include_usage
    Тип: boolean

    Включать сведения об использовании ресурсов в ответ. Это не информация о биллинге Felo.

  • query
    Тип: string

    Пользовательское намерение для повторного ранжирования извлечённых чанков контента.

  • timeout
    Тип: number Формат: float
    мин.:  
    1
    макс.:  
    60

    Максимальное время ожидания извлечения URL в секундах. Если опущено, таймауты по умолчанию зависят от extract_depth: 10 секунд для basic и 30 секунд для advanced.

Ответы
  • 200
    Тип: object

    Результаты извлечения успешно возвращены.

    • failed_results
      Тип: array string[]

      Список URL, которые не удалось обработать.

    • request_id
      Тип: string

      Уникальный идентификатор запроса.

    • response_time
      Тип: number Формат: float

      Время выполнения запроса в секундах.

    • results
      Тип: array object[]
      • favicon
        Тип: string | null

        URL favicon извлечённого контента.

      • images
        Тип: array string[]

        Изображения, извлечённые из URL, когда include_images имеет значение true.

      • raw_content
        Тип: string

        Необработанный контент, извлечённый из URL.

      • title
        Тип: string

        Заголовок извлечённой страницы.

      • url
        Тип: string

        URL извлечённого контента.

    • usage
      Тип: object
      • credits
        Тип: integer

        Единицы ресурсов, израсходованные этим запросом; не USD и не кредиты Felo.

    application/json
  • 400

    Запрос не удалось обработать. Проверьте параметры запроса.

  • 401

    Требуется действительный API-ключ Felo.

  • 402

    Запрос не может быть выполнен: не выполнено требование биллинга.

  • 403

    Аккаунту не разрешено выполнять эту операцию.

  • 429

    Достигнут лимит запросов или расходов.

  • 502

    Сервис не смог выполнить запрос.

  • 503

    API или сервис биллинга временно недоступны.

  • 504

    Истекло время ожидания обработки запроса.

  • default

    Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

    application/json
Request Example for post/v1/beta/tavily/extract
curl --request POST https://openapi.felo.ai/v1/beta/tavily/extract \
  --header "Authorization: Bearer ${FELO_API_KEY:?Set FELO_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{"urls": ["https://example.com"], "extract_depth": "basic", "format": "text", "include_usage": true}'
{
  "results": [
    {
      "url": "https://example.com",
      "title": "Example Domain",
      "raw_content": "This domain is for use in documentation examples.",
      "images": []
    }
  ],
  "failed_results": [],
  "response_time": 0.5,
  "usage": {
    "credits": 1
  },
  "request_id": "example-extract-request"
}
Tavily Extract

Нужна помощь?