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.

Справочная информация о ценах

  • Тарификация: справочная стоимость по тарифицируемым результатам.
  • Справочная оценка запроса: недоступна.
  • Справочная цена за единицу для клиента: 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 enum
    значения
    • 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 enum
      обязательно
      значения
      • 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.

Нужна помощь?