Felo API PlatformFelo API Platform
endpoint ทั้งหมดของ Firecrawl
v0.2.0-beta
OpenAPI 3.1.0

ส่งงาน crawl แบบอะซิงโครนัส

เซิร์ฟเวอร์:https://openapi.felo.ai
ไลบรารีไคลเอนต์

Firecrawl

​

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

Firecrawl การดำเนินการ

ส่งงาน crawl แบบอะซิงโครนัส

​

ส่งการ crawl เว็บไซต์แบบอะซิงโครนัส ระบุ url และ limit และอาจระบุตัวเลือกการ crawl และ scrape ตามเอกสาร ต้องมี Idempotency-Key HTTP 202 คืน job ใช้ id ของ job กับ endpoint การ poll ของ Felo ที่เกี่ยวข้องจนกว่าจะ completed, failed หรือ cancelled ฟิลด์ราคาของ job เป็นข้อมูลเมตาการอนุญาตและการชำระบัญชีของผู้ให้บริการ ไม่ใช่บันทึกการเรียกเก็บเงินของ Felo

ข้อมูลอ้างอิงราคา

  • การวัดปริมาณการใช้งาน: อ้างอิงผลลัพธ์แบบมิเตอร์
  • ค่าประมาณคำขออ้างอิง: ไม่มีข้อมูล
  • ราคาอ้างอิงต่อหน่วยสำหรับลูกค้า: USD 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 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 ที่ระบุไว้ในเอกสารสำหรับการ polling

    • error
      ประเภท: object | null
      จำเป็น
      • code
        ประเภท: string | null
      • message
        ประเภท: string | null
    • id
      ประเภท: string | null
      จำเป็น
    • object
      const:  
      integration_async_job
      จำเป็น
    • output
      จำเป็น
    • pricing
      ประเภท: object | null
      จำเป็น

      ข้อมูลเมตาการอนุญาตและการชำระบัญชีของผู้ให้บริการในหน่วย micro-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

    จำเป็นต้องใช้คีย์ API ของ Felo ที่ถูกต้อง

  • 402

    ไม่สามารถดำเนินการตามคำขอได้ เนื่องจากไม่เป็นไปตามข้อกำหนดด้านการเรียกเก็บเงิน

  • 403

    บัญชีไม่ได้รับอนุญาตให้ดำเนินการนี้

  • 429

    ถึงขีดจำกัดคำขอหรือการใช้จ่ายแล้ว

  • 502

    บริการไม่สามารถดำเนินการตามคำขอให้เสร็จสิ้นได้

  • 503

    API หรือบริการเรียกเก็บเงินไม่พร้อมใช้งานชั่วคราว

  • 504

    บริการหมดเวลาระหว่างประมวลผลคำขอ

  • default

    การดำเนินการล้มเหลว โปรดเก็บ request ID ของการตอบกลับไว้เมื่อติดต่อฝ่ายสนับสนุนของ 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.