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

خراش یک صفحه و برگرداندن محتوای اصلی آن به‌صورت markdown.

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

Firecrawl

​

Search, scrape, map, file parsing and asynchronous crawling.

Firecrawl عملیات

خراش یک صفحه و برگرداندن محتوای اصلی آن به‌صورت markdown.

​

یک نشانی را واکشی کنید و محتوای اصلی آن را به‌صورت markdown بگیرید. url و proxy هر دو الزامی‌اند — proxy در پروفایل اندازه‌گیری‌شده باید basic باشد — و formats خروجی را انتخاب می‌کند. success و data را با markdown به‌همراه شیء metadata بزرگی که تگ‌های og: و twitter: صفحه، statusCode، sourceURL و language را دارد برمی‌گرداند. ⚠️ نشانی باید HTTPS باشد و نباید به PDF اشاره کند؛ هر دو رد می‌شوند نه با بهترین تلاش. وقتی نشانی را دارید و متن را می‌خواهید از آن استفاده کنید. برای چند نشانی هم‌زمان post_firecrawl_batch_scrape آن‌ها را به‌عنوان یک کار پس‌زمینه اجرا می‌کند و extractWebContent یک دسته کوچک را همگام انجام می‌دهد. برای یافتن نشانی‌ها ابتدا post_firecrawl_map.

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

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

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

بدنه
الزامی
application/json
  • proxy
    فهرست مقادیر
    مقدار ثابت:  
    basic
    الزامی
    مقادیر
    • basic
  • url
    نوع: string قالب: https_url
    الزامی

    پسوندهای پشتیبانی‌نشده: .pdf.

  • formats
    نوع: array string[] 1…1فهرست مقادیر
    مقدار ثابت:  
    [ "markdown" ]
    مقادیر
    • markdown
  • onlyCleanContent
    نوع: boolean فهرست مقادیر
    مقدار ثابت:  
    false
    مقادیر
    • false
پاسخ‌ها
  • 200
    نوع: object

    خراش با موفقیت تکمیل شد.

    • creditsUsed
      نوع: integer

      اعتبارهای Firecrawl مصرف‌شده توسط درخواست (1 برای هر صفحه).

    • data
      نوع: object
      • markdown
        نوع: string

        محتوای صفحه خراش‌داده‌شده به markdown.

      • metadata
        نوع: object

        فراداده صفحه مانند عنوان، توضیحات، نشانی URL منبع و وضعیت HTTP.

        • description
          نوع: string
        • sourceURL
          نوع: string
        • statusCode
          نوع: integer

          Integer numbers.

        • title
          نوع: string
    • success
      نوع: boolean

      true وقتی خراش موفق باشد.

    application/json
  • 400

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

  • 401

    یک کلید API معتبر Felo لازم است.

  • 402

    درخواست ادامه نمی‌یابد چون یک الزام صورت‌حساب برآورده نشده است.

  • 403

    حساب مجاز به انجام این عملیات نیست.

  • 429

    به سقف درخواست یا هزینه رسیده‌اید.

  • 502

    سرویس نتوانست درخواست را کامل کند.

  • 503

    سرویس API یا صورت‌حساب موقتاً در دسترس نیست.

  • 504

    سرویس هنگام پردازش درخواست به پایان مهلت رسید.

  • default

    پاسخ خطا؛ پاسخ‌های عبوری بالادست ممکن است از قالب‌های ارائه‌دهنده استفاده کنند

    application/json
Request Example for post/v1/beta/firecrawl/scrape
curl https://openapi.felo.ai/v1/beta/firecrawl/scrape \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "proxy": "basic",
  "url": "https://example.com"
}'
{
  "success": true,
  "data": {
    "markdown": "string",
    "metadata": {
      "title": "string",
      "description": "string",
      "sourceURL": "string",
      "statusCode": 1
    }
  },
  "creditsUsed": 1
}
Scrape a single page and return its main content as markdown.