Felo API PlatformFelo API Platform
تمام Firecrawl endpoints
v0.2.0-beta
OpenAPI 3.1.0

ایک async کرال جاب جمع کریں۔

Felo API Support
MIT
سرور:https://openapi.felo.ai
کلائنٹ لائبریریاں
Shell Curl

Firecrawl

​

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

Firecrawl آپریشنز

ایک async کرال جاب جمع کریں۔

​

ایک async ویب سائٹ کرال جمع کریں۔ url اور limit فراہم کریں؛ اختیاری طور پر دستاویزی کرال اور اسکریپ آپشنز۔ Idempotency-Key درکار ہے۔ HTTP 202 ایک جاب واپس کرتا ہے؛ اسے completed، failed یا cancelled ہونے تک متعلقہ Felo پولنگ endpoint کے ساتھ استعمال کریں۔ جاب کی قیمت کے فیلڈز پرووائیڈر کی اجازت اور تصفیے کا میٹا ڈیٹا ہیں، نہ کہ Felo کے بلنگ ریکارڈز۔

قیمت کا حوالہ

  • میٹرنگ: میٹر شدہ نتائج کا حوالہ۔
  • حوالہ جاتی درخواست کا تخمینہ دستیاب نہیں۔
  • صارف کے فی یونٹ حوالہ جاتی قیمت: USD 0.005۔

صرف حوالہ جاتی میٹا ڈیٹا، نہ کہ اکاؤنٹ کا کوٹ، ضمانت شدہ قیمت یا اخراجات کی حد۔ ریسورس کریڈٹس Felo کریڈٹس نہیں ہیں۔ حتمی چارجز Felo کے بلنگ ریکارڈز کے مطابق ہوں گے۔

ہیڈرز
  • Idempotency-Key
    قسم: string
    لازمی

    تراشے جانے کے بعد UTF-8 لمبائی 1 سے 191 بائٹس تک ہونی چاہیے۔

باڈی
لازمی
application/json
  • limit
    قسم: integer
    کم از کم:  
    1
    زیادہ سے زیادہ:  
    1000
    لازمی

    Integer numbers.

  • url
    قسم: string
    لازمی

    ہوسٹ نام والا HTTPS URL، بغیر اسناد یا فراگمنٹ کے۔ .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 enum
    اقدار
    • 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 job path استعمال کریں۔

    • error
      قسم: object | null
      لازمی
      • code
        قسم: string | null
      • message
        قسم: string | null
    • id
      قسم: string | null
      لازمی
    • object
      const:  
      integration_async_job
      لازمی
    • output
      لازمی
    • pricing
      قسم: object | null
      لازمی

      مائیکرو-USD میں پرووائیڈر اجازت اور تصفیہ میٹا ڈیٹا؛ یہ Felo بیلنس، ہولڈ یا بلنگ رسید نہیں ہے۔

      • authorizedMicrosUSD
        قسم: integer | null

        Integer numbers.

      • billingMode
        قسم: string | null
      • currency
        قسم: string | null
      • finalMicrosUSD
        قسم: integer | null

        Integer numbers.

    • status
      قسم: string enum
      لازمی
      اقدار
      • queued
      • running
      • completed
      • failed
      • cancelled
    • outputExpired
      قسم: boolean | null
    application/json
  • 400

    درخواست پر کارروائی نہیں ہو سکی۔ درخواست کے پیرامیٹرز چیک کریں۔

  • 401

    درست Felo API کلید درکار ہے۔

  • 402

    درخواست آگے نہیں بڑھ سکتی کیونکہ بلنگ کی شرط پوری نہیں ہوئی۔

  • 403

    اکاؤنٹ کو یہ آپریشن کرنے کی اجازت نہیں۔

  • 429

    درخواست یا اخراجات کی حد پوری ہو گئی ہے۔

  • 502

    سروس درخواست مکمل نہیں کر سکی۔

  • 503

    API یا بلنگ سروس عارضی طور پر دستیاب نہیں۔

  • 504

    درخواست پر کارروائی کے دوران سروس کا وقت ختم ہو گیا۔

  • default

    آپریشن ناکام رہا۔ Felo سپورٹ سے رابطہ کرتے وقت جواب کا request ID محفوظ رکھیں۔

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.