v0.2.0-beta

OpenAPI 3.1.0

Інструмент обходу сайтів на основі графа з використанням Tavily Crawl.

Felo API Support

MIT

Сервер

https://openapi.felo.ai

Клієнтські бібліотеки

Shell Curl

Web Content

Web crawling, URL discovery and page extraction.

Web Content Операції

post/v1/beta/tavily/crawl

Інструмент обходу сайтів на основі графа з використанням 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 перелік

Глибина процесу вилучення.
значення
- basic
- advanced
format
Тип: string перелік

Формат вилученого вмісту вебсторінки.
значення
- 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

Відповідь із помилкою; наскрізні відповіді апстріму можуть використовувати формати постачальника

application/json

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"
}

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

Інструмент обходу сайтів на основі графа з використанням Tavily Crawl.

АвтентифікаціяRequired

Web Content

Інструмент обходу сайтів на основі графа з використанням Tavily Crawl.

Довідкові ціни