Felo API PlatformFelo API Platform
جميع endpoints الخاصة بـ 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
    مطلوب

    عنوان URL من نوع HTTPS باسم مضيف، بلا بيانات اعتماد أو جزء مرساة. لا يُدعم الإدخال المشذّب المنتهي بـ .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.