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.

需要帮助？