v0.2.0-beta

OpenAPI 3.1.0

Gửi tác vụ crawl bất đồng bộ.

Felo API Support

MIT

Máy chủ

https://openapi.felo.ai

Thư viện client

Shell Curl

Firecrawl

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

Firecrawl Thao tác

post/v1/beta/firecrawl/crawl

Gửi tác vụ crawl bất đồng bộ.

Gửi một lần crawl trang web bất đồng bộ. Cung cấp url và limit; tùy chọn các tùy chọn crawl và scrape đã được ghi tài liệu. Idempotency-Key là bắt buộc. HTTP 202 trả về một tác vụ; dùng id của tác vụ với endpoint thăm dò tương ứng của Felo cho tới khi completed, failed hoặc cancelled. Các trường giá của tác vụ là siêu dữ liệu ủy quyền và quyết toán của nhà cung cấp, không phải bản ghi thanh toán Felo.

Tham chiếu giá

Đo lường: Tham chiếu theo kết quả được đo lường.
Ước tính tham chiếu cho mỗi yêu cầu: không khả dụng.
Giá tham chiếu đơn vị khách hàng: USD 0.005.

Chỉ là siêu dữ liệu tham chiếu, không phải báo giá cho tài khoản, mức giá được bảo đảm hay hạn mức chi tiêu. Tín dụng tài nguyên không phải tín dụng Felo. Khoản phí cuối cùng tuân theo bản ghi thanh toán của Felo.

Header

Idempotency-Key
Kiểu: string
bắt buộc

Độ dài UTF-8 sau khi cắt phải từ 1 đến 191 byte.

Phần thân

bắt buộc

application/json

limit
Kiểu: integer
tối thiểu:
1
tối đa:
1000
bắt buộc

Integer numbers.
url
Kiểu: string
bắt buộc

URL HTTPS có tên máy chủ, không có thông tin xác thực hoặc fragment. Đầu vào sau khi cắt khoảng trắng kết thúc bằng .pdf (không phân biệt chữ hoa/thường) không được hỗ trợ.
allowExternalLinks
Kiểu: boolean | null
allowSubdomains
Kiểu: boolean | null
crawlEntireDomain
Kiểu: boolean | null
delay
Kiểu: number | null
tối thiểu:
0
tối đa:
30
excludePaths
Kiểu: array string[] | null …20
ignoreQueryParameters
Kiểu: boolean | null
includePaths
Kiểu: array string[] | null …20
maxConcurrency
Kiểu: integer | null
tối thiểu:
1
tối đa:
20

Integer numbers.
maxDiscoveryDepth
Kiểu: integer | null
tối thiểu:
0
tối đa:
10

Integer numbers.
scrapeOptions
Kiểu: object | null
- excludeTags
  Kiểu: array string[] | null …50
- includeTags
  Kiểu: array string[] | null …50
- maxAge
  Kiểu: integer | null
  tối thiểu:
  0
  tối đa:
  31536000000
  
  Integer numbers.
- minAge
  Kiểu: integer | null
  tối thiểu:
  0
  tối đa:
  31536000000
  
  Integer numbers.
- onlyMainContent
  Kiểu: boolean | null
- timeout
  Kiểu: integer | null
  tối thiểu:
  1000
  tối đa:
  300000
  
  Integer numbers.

sitemap
Kiểu: string | null enum
giá trị
- null
- skip
- include
- only

Phản hồi

202
Kiểu: object

Thành công
completedAt
Kiểu: string | null Định dạng: date-time
bắt buộc

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

createdAt
Kiểu: string | null Định dạng: date-time
bắt buộc

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endpoint
Kiểu: string | null
bắt buộc

Mã định danh thao tác của nhà cung cấp; dùng đường dẫn tác vụ Felo được ghi trong tài liệu để thăm dò.

error
Kiểu: object | null
bắt buộc
code
Kiểu: string | null
message
Kiểu: string | null
id
Kiểu: string | null
bắt buộc
object
const:
integration_async_job
bắt buộc
output
bắt buộc
pricing
Kiểu: object | null
bắt buộc

Siêu dữ liệu ủy quyền và thanh toán của nhà cung cấp tính bằng micro-USD; không phải số dư Felo, khoản giữ hay biên nhận thanh toán.

authorizedMicrosUSD
Kiểu: integer | null

Integer numbers.

billingMode
Kiểu: string | null
currency
Kiểu: string | null
finalMicrosUSD
Kiểu: integer | null

Integer numbers.

status
Kiểu: string enum
bắt buộc
giá trị
queued
running
completed
failed
cancelled
outputExpired
Kiểu: boolean | null
application/json
400

Không thể xử lý yêu cầu. Hãy kiểm tra các tham số yêu cầu.
401

Cần có khóa API Felo hợp lệ.
402

Không thể tiếp tục yêu cầu vì chưa đáp ứng yêu cầu thanh toán.
403

Tài khoản không được phép thực hiện thao tác này.
429

Đã đạt giới hạn yêu cầu hoặc giới hạn chi tiêu.
502

Dịch vụ không thể hoàn tất yêu cầu.
503

API hoặc dịch vụ thanh toán tạm thời không khả dụng.
504

Dịch vụ đã hết thời gian chờ khi xử lý yêu cầu.
default

Thao tác thất bại. Hãy giữ ID yêu cầu của phản hồi khi liên hệ hỗ trợ Felo.

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
}'

Hiện schema

{
  "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"
}

Thành công

Gửi tác vụ crawl bất đồng bộ.

Xác thựcRequired

Firecrawl

Gửi tác vụ crawl bất đồng bộ.

Tham chiếu giá