Felo API PlatformFelo API Platform
全部 Firecrawl 端點
v0.2.0-beta
OpenAPI 3.1.0

提交非同步爬取任務。

Felo API Support
MIT
伺服器:https://openapi.felo.ai
用戶端程式庫
Shell Curl

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 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 列舉
    值
    • 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 餘額、凍結金額或帳單憑證。

      • 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

    需要有效的 Felo API 金鑰。

  • 402

    由於未符合計費要求，要求無法繼續。

  • 403

    該帳戶無權執行此操作。

  • 429

    已達到要求或支出上限。

  • 502

    服務無法完成該要求。

  • 503

    API 或計費服務暫時無法使用。

  • 504

    服務在處理要求時逾時。

  • default

    操作失敗。聯絡 Felo 支援時請保留回應的請求 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.

需要協助嗎？