Felo API PlatformFelo API Platform
همه endpointهای Tavily
v0.2.0-beta
OpenAPI 3.1.0

نقشه‌های جامع سایت را با Tavily Map تولید کنید.

سرور:https://openapi.felo.ai
کتابخانه‌های کلاینت

Web Content

​

Web crawling, URL discovery and page extraction.

Web Content عملیات

نقشه‌های جامع سایت را با Tavily Map تولید کنید.

​

URLهای یک سایت را از url ریشه بدون واکشی محتوای هیچ صفحه‌ای فهرست می‌کند. آن را با instructions به زبان طبیعی و فیلترهای regex select_paths / exclude_paths / select_domains هدایت کنید. base_url و results — آرایه‌ای تخت از رشته‌های URL، نه اشیاء — را با response_time و request_id برمی‌گرداند. از آن برای سنجش اندازه یک سایت پیش از اقدام به خزش استفاده کنید، سپس فقط بخش‌های مهم را با extractWebContent واکشی کنید. وقتی محتوا را می‌خواهید نه شکل را، post_tavily_crawl هر دو را در یک فراخوانی انجام می‌دهد.

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

  • اندازه‌گیری: واحدهای پاسخ اندازه‌گیری‌شده.
  • برآورد درخواست مرجع: 0.064 دلار آمریکا.
  • مبنای هزینه واحد: 0.008 دلار آمریکا.
  • واحد منبع: tavily_credit.
  • ضریب مشتری مرجع: 1.0. آن را دوباره روی مبلغ تسویه‌شده مشتری اعمال نکنید.
  • مبناهای هزینه، قیمت نهایی مشتری را تعیین نمی‌کنند، از جمله وقتی صفر باشند.

فقط فراداده مرجع است، نه نقل‌قول حساب، نه قیمت تضمین‌شده و نه سقف هزینه. اعتبار منابع، اعتبار Felo نیست. هزینه‌های نهایی تابع سوابق صورت‌حساب Felo است.

بدنه
الزامی
application/json
  • url
    نوع: string
    الزامی

    URL ریشه برای شروع نقشه‌برداری.

  • allow_external
    نوع: boolean

    شامل‌کردن پیوندهای دامنه‌های خارجی در فهرست نتایج نهایی.

  • exclude_domains
    نوع: array string[]

    الگوهای regex برای حذف دامنه‌ها یا زیردامنه‌های مشخص از نقشه‌برداری.

  • exclude_paths
    نوع: array string[]

    الگوهای regex برای حذف URLهایی با الگوهای مسیر مشخص.

  • 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

    نتایج Map با موفقیت برگردانده شد.

    • base_url
      نوع: string

      URL پایه‌ای که نقشه‌برداری شده است.

    • request_id
      نوع: string

      شناسه یکتای درخواست.

    • response_time
      نوع: number قالب: float

      زمان به ثانیه که تکمیل درخواست طول کشید.

    • results
      نوع: array string[]
    • 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/map
curl https://openapi.felo.ai/v1/beta/tavily/map \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "url": "docs.tavily.com",
  "instructions": "",
  "max_depth": 1,
  "max_breadth": 20,
  "limit": 50,
  "select_paths": [
    ""
  ],
  "select_domains": [
    ""
  ],
  "exclude_paths": [
    ""
  ],
  "exclude_domains": [
    ""
  ],
  "allow_external": true,
  "timeout": 150,
  "include_usage": false
}'
{
  "base_url": "string",
  "results": [
    "string"
  ],
  "response_time": 1,
  "usage": {
    "credits": 1
  },
  "request_id": "string"
}
Generate comprehensive site maps using Tavily Map.