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

Инструмент обхода сайтов на основе графа с использованием Tavily Crawl.

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

Web Content

​

Web crawling, URL discovery and page extraction.

Web Content Операции

Инструмент обхода сайтов на основе графа с использованием Tavily Crawl.

​

Обходит сайт от корневого url и возвращает содержимое найденных страниц. Управляйте обходом с помощью instructions на естественном языке и фильтров путей и доменов на регулярных выражениях, а ограничивайте его через max_depth, max_breadth и limit. Возвращает base_url и results[] с url и raw_content. Используйте для широкого охвата одного сайта — документации, каталога, блога конкурента. Отвечает синхронно, в отличие от post_firecrawl_crawl: тот выполняется как фоновая задача и подходит для обходов, которые слишком велики, чтобы их ждать.

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

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

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

Тело
обязательно
application/json
  • url
    Тип: string
    обязательно

    Корневой URL для начала обхода.

  • allow_external
    Тип: boolean

    Включать ссылки на внешние домены в итоговый список результатов.

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

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

  • exclude_domains
    Тип: array string[]

    Regex-шаблоны для исключения конкретных доменов или поддоменов из обхода.

  • exclude_paths
    Тип: array string[]

    Regex-шаблоны для исключения URL с определёнными шаблонами путей.

  • extract_depth
    Тип: string enum

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

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

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

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

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

  • include_images
    Тип: boolean

    Включать изображения в результаты обхода.

  • include_usage
    Тип: boolean

    Включать сведения об использовании кредитов в ответ.

  • instructions
    Тип: string

    Инструкции для краулера на естественном языке.

  • limit
    Тип: integer
    мин.:  
    1

    Общее количество ссылок, которые краулер обработает до остановки.

  • max_breadth
    Тип: integer
    мин.:  
    1
    макс.:  
    500

    Максимальное количество ссылок для перехода на каждом уровне дерева.

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

    Максимальная глубина обхода.

  • select_domains
    Тип: array string[]

    Regex-шаблоны для выбора обхода только конкретных доменов или поддоменов.

  • select_paths
    Тип: array string[]

    Regex-шаблоны для выбора только URL с определёнными шаблонами путей.

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

    Максимальное время ожидания операции обхода в секундах.

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

    Результаты обхода успешно возвращены.

    • base_url
      Тип: string

      Базовый URL, который был обойдён.

    • request_id
      Тип: string

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

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

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

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

        URL favicon обойдённой страницы.

      • raw_content
        Тип: string

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

      • url
        Тип: string

        URL обойдённой страницы.

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

        Сведения об использовании кредитов для запроса.

    application/json
  • 400

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

  • 401

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

  • 402

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

  • 403

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

  • 429

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

  • 502

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

  • 503

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

  • 504

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

  • default

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

    application/json
Request Example for post/v1/beta/tavily/crawl
curl https://openapi.felo.ai/v1/beta/tavily/crawl \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "url": "docs.tavily.com",
  "instructions": "",
  "chunks_per_source": 3,
  "max_depth": 1,
  "max_breadth": 20,
  "limit": 50,
  "select_paths": [
    ""
  ],
  "select_domains": [
    ""
  ],
  "exclude_paths": [
    ""
  ],
  "exclude_domains": [
    ""
  ],
  "allow_external": true,
  "include_images": false,
  "extract_depth": "basic",
  "format": "markdown",
  "include_favicon": false,
  "timeout": 150,
  "include_usage": false
}'
{
  "base_url": "string",
  "results": [
    {
      "url": "string",
      "raw_content": "string",
      "favicon": "string"
    }
  ],
  "response_time": 1,
  "usage": {
    "credits": 1
  },
  "request_id": "string"
}
Graph-based website traversal tool using Tavily Crawl.

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