Felo API PlatformFelo API Platform
همه endpointهای 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 به زبان طبیعی به‌همراه فیلترهای regex مسیر و دامنه هدایت کنید و با max_depth، max_breadth و limit محدود کنید. base_url و results[] را با url و raw_content برمی‌گرداند. برای پوشش گسترده یک سایت — مستندات، یک کاتالوگ، وبلاگ یک رقیب — از آن استفاده کنید. همگام پاسخ می‌دهد، برخلاف post_firecrawl_crawl: آن یکی به‌صورت کار پس‌زمینه اجرا می‌شود و برای خزش‌هایی مناسب است که بیش از حد بزرگ‌اند برای انتظار.

مرجع قیمت‌گذاری

  • اندازه‌گیری: واحدهای پاسخ اندازه‌گیری‌شده.
  • برآورد درخواست مرجع: 0.024 دلار آمریکا.
  • مبنای هزینه واحد: 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 فاوآیکون برای هر نتیجه.

  • 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 فاوآیکون صفحه خزش‌شده.

      • 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
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.