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

ارسال یک کار خزش ناهمگام.

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

Firecrawl

​

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

Firecrawl عملیات

ارسال یک کار خزش ناهمگام.

​

یک خزش وب‌سایت ناهمگام ارسال کنید. url و limit را بدهید؛ به‌صورت اختیاری گزینه‌های مستند خزش و خراش. Idempotency-Key الزامی است. HTTP 202 یک کار برمی‌گرداند؛ id آن را با نقطه پایانی بررسی دوره‌ای متناظر Felo تا رسیدن به completed، failed یا cancelled استفاده کنید. فیلدهای قیمت‌گذاری کار، مجوز ارائه‌دهنده و فراداده تسویه‌اند، نه سوابق صورت‌حساب Felo.

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

  • اندازه‌گیری: مرجع نتایج اندازه‌گیری‌شده.
  • برآورد درخواست مرجع: در دسترس نیست.
  • قیمت واحد مرجع مشتری: 0.005 دلار آمریکا.

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

هدرها
  • Idempotency-Key
    نوع: string
    الزامی

    طول UTF-8 پس از حذف فاصله‌ها باید بین 1 تا 191 بایت باشد.

بدنه
الزامی
application/json
  • limit
    نوع: integer
    حداقل:  
    1
    حداکثر:  
    1000
    الزامی

    Integer numbers.

  • url
    نوع: string
    الزامی

    نشانی HTTPS با نام میزبان، بدون اعتبارنامه یا fragment. ورودی اصلاح‌شده‌ای که به .pdf ختم می‌شود (بدون حساسیت به بزرگی و کوچکی حروف) پشتیبانی نمی‌شود.

  • نوع: boolean | null
  • allowSubdomains
    نوع: boolean | null
  • crawlEntireDomain
    نوع: boolean | null
  • delay
    نوع: number | null
    حداقل:  
    0
    حداکثر:  
    30
  • excludePaths
    نوع: array string[] | null …20
  • ignoreQueryParameters
    نوع: boolean | null
  • includePaths
    نوع: array string[] | null …20
  • maxConcurrency
    نوع: integer | null
    حداقل:  
    1
    حداکثر:  
    20

    Integer numbers.

  • maxDiscoveryDepth
    نوع: integer | null
    حداقل:  
    0
    حداکثر:  
    10

    Integer numbers.

  • scrapeOptions
    نوع: object | null
    • excludeTags
      نوع: array string[] | null …50
    • includeTags
      نوع: array string[] | null …50
    • maxAge
      نوع: integer | null
      حداقل:  
      0
      حداکثر:  
      31536000000

      Integer numbers.

    • minAge
      نوع: integer | null
      حداقل:  
      0
      حداکثر:  
      31536000000

      Integer numbers.

    • onlyMainContent
      نوع: boolean | null
    • timeout
      نوع: integer | null
      حداقل:  
      1000
      حداکثر:  
      300000

      Integer numbers.

  • sitemap
    نوع: string | null فهرست مقادیر
    مقادیر
    • null
    • skip
    • include
    • only
پاسخ‌ها
  • 202
    نوع: object

    موفقیت

    • completedAt
      نوع: string | null قالب: date-time
      الزامی

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • createdAt
      نوع: string | null قالب: date-time
      الزامی

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • endpoint
      نوع: string | null
      الزامی

      شناسه عملیات ارائه‌دهنده؛ برای نظرسنجی از مسیر مستند وظیفه Felo استفاده کنید.

    • error
      نوع: object | null
      الزامی
      • code
        نوع: string | null
      • message
        نوع: string | null
    • id
      نوع: string | null
      الزامی
    • object
      مقدار ثابت:  
      integration_async_job
      الزامی
    • output
      الزامی
    • pricing
      نوع: object | null
      الزامی

      فراداده مجوز و تسویه ارائه‌دهنده به میکرو-دلار؛ نه موجودی Felo، نه بلوکه و نه رسید صورت‌حساب Felo.

      • authorizedMicrosUSD
        نوع: integer | null

        Integer numbers.

      • billingMode
        نوع: string | null
      • currency
        نوع: string | null
      • finalMicrosUSD
        نوع: integer | null

        Integer numbers.

    • status
      نوع: string فهرست مقادیر
      الزامی
      مقادیر
      • queued
      • running
      • completed
      • failed
      • cancelled
    • outputExpired
      نوع: boolean | null
    application/json
  • 400

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

  • 401

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

  • 402

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

  • 403

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

  • 429

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

  • 502

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

  • 503

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

  • 504

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

  • default

    عملیات ناموفق بود. هنگام تماس با پشتیبانی Felo، شناسه درخواست پاسخ را نگه دارید.

Request Example for post/v1/beta/firecrawl/crawl
curl https://openapi.felo.ai/v1/beta/firecrawl/crawl \
  --request POST \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "url": "https://example.com",
  "limit": 1
}'
{
  "completedAt": null,
  "createdAt": null,
  "endpoint": null,
  "error": {
    "code": null,
    "message": null
  },
  "id": null,
  "object": "integration_async_job",
  "output": null,
  "outputExpired": null,
  "pricing": {
    "authorizedMicrosUSD": null,
    "billingMode": null,
    "currency": null,
    "finalMicrosUSD": null
  },
  "status": "queued"
}
Submit an asynchronous crawl job.