Felo API PlatformFelo API Platform
सभी Firecrawl endpoint
v0.2.0-beta
OpenAPI 3.1.0

असिंक्रोनस क्रॉल जॉब सबमिट करें।

सर्वर:https://openapi.felo.ai
क्लाइंट लाइब्रेरी

Firecrawl

​

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

Firecrawl ऑपरेशन

असिंक्रोनस क्रॉल जॉब सबमिट करें।

​

असिंक्रोनस वेबसाइट क्रॉल सबमिट करें। url और limit दें; वैकल्पिक रूप से दस्तावेज़ीकृत क्रॉल और स्क्रैप विकल्प। Idempotency-Key आवश्यक है। HTTP 202 एक जॉब लौटाता है; संबंधित Felo पोलिंग endpoint के साथ उसका id तब तक उपयोग करें जब तक वह completed, failed या cancelled न हो जाए। जॉब के मूल्य फ़ील्ड प्रोवाइडर प्राधिकरण और निपटान मेटाडेटा हैं, Felo बिलिंग रिकॉर्ड नहीं।

मूल्य संदर्भ

  • मीटरिंग: मीटर किए गए परिणाम का संदर्भ
  • संदर्भ request अनुमान उपलब्ध नहीं।
  • ग्राहक यूनिट संदर्भ मूल्य: USD 0.005

यह केवल संदर्भ मेटाडेटा है — खाते का कोटेशन, गारंटीशुदा मूल्य या खर्च सीमा नहीं। रिसोर्स क्रेडिट Felo क्रेडिट नहीं हैं। अंतिम शुल्क Felo बिलिंग रिकॉर्ड के अनुसार लगते हैं।

headers
  • Idempotency-Key
    टाइप: string
    आवश्यक

    साफ़ किए गए (trimmed) 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
responses
  • 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 पथ का उपयोग करें।

    • 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

    request संसाधित नहीं किया जा सका। request पैरामीटर जाँचें।

  • 401

    एक वैध Felo API key आवश्यक है।

  • 402

    request आगे नहीं बढ़ सकता क्योंकि बिलिंग आवश्यकता पूरी नहीं हुई है।

  • 403

    खाते को यह ऑपरेशन करने की अनुमति नहीं है।

  • 429

    request या खर्च की सीमा तक पहुँच गए हैं।

  • 502

    सेवा request पूरा नहीं कर सकी।

  • 503

    API या बिलिंग सेवा अस्थायी रूप से उपलब्ध नहीं है।

  • 504

    request संसाधित करते समय सेवा का समय समाप्त हो गया।

  • default

    ऑपरेशन विफल रहा। Felo सहायता से संपर्क करते समय response का 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.