Felo API PlatformFelo API Platform
Усі endpoint 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.

Довідкові ціни

  • Тарифікація: довідкова вартість за тарифікованими результатами.
  • Довідкова оцінка запиту: недоступна.
  • Довідкова ціна за одиницю для клієнта: USD 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
      обов'язкове

      Метадані авторизації та розрахунків постачальника в мікро-USD; це не баланс 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

    Потрібен дійсний API-ключ Felo.

  • 402

    Запит неможливо виконати: умови білінгу не виконано.

  • 403

    Обліковий запис не має дозволу на цю операцію.

  • 429

    Досягнуто ліміту запитів або витрат.

  • 502

    Служба не змогла виконати запит.

  • 503

    API або служба білінгу тимчасово недоступні.

  • 504

    Час очікування обробки запиту вичерпано.

  • default

    Операція завершилася помилкою. Збережіть 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.