Felo API PlatformFelo API Platform
Todos os endpoints de Firecrawl
v0.2.0-beta
OpenAPI 3.1.0

Enviar um job de rastreamento assíncrono.

Servidor:https://openapi.felo.ai
Bibliotecas Cliente

Firecrawl

​

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

Firecrawl Operações

Enviar um job de rastreamento assíncrono.

​

Envia um rastreamento de site assíncrono. Informe url e limit; opcionalmente, as opções de rastreamento e scrape documentadas. Idempotency-Key é obrigatório. HTTP 202 retorna um job; use seu id com o endpoint de consulta correspondente da Felo até completed, failed ou cancelled. Os campos de preço do job são metadados de autorização e liquidação do provedor, não registros de cobrança da Felo.

Referência de preços

  • Medição: referência por resultado medido.
  • Estimativa de referência por requisição indisponível.
  • Preço unitário de referência do cliente: USD 0.005.

Apenas metadados de referência, não uma cotação da conta, um preço garantido ou um limite de gastos. Créditos de recursos não são créditos Felo. As cobranças finais seguem os registros de cobrança da Felo.

Cabeçalhos
  • Idempotency-Key
    Tipo: string
    obrigatório

    O comprimento UTF-8 aparado deve ser de 1 a 191 bytes.

Corpo
obrigatório
application/json
  • limit
    Tipo: integer
    mín:  
    1
    máx:  
    1000
    obrigatório

    Integer numbers.

  • url
    Tipo: string
    obrigatório

    URL HTTPS com um nome de host, sem credenciais nem fragmento. Entradas sem espaços nas extremidades terminadas em .pdf (sem diferenciar maiúsculas de minúsculas) não são suportadas.

  • Tipo: boolean | null
  • allowSubdomains
    Tipo: boolean | null
  • crawlEntireDomain
    Tipo: boolean | null
  • delay
    Tipo: number | null
    mín:  
    0
    máx:  
    30
  • excludePaths
    Tipo: array string[] | null …20
  • ignoreQueryParameters
    Tipo: boolean | null
  • includePaths
    Tipo: array string[] | null …20
  • maxConcurrency
    Tipo: integer | null
    mín:  
    1
    máx:  
    20

    Integer numbers.

  • maxDiscoveryDepth
    Tipo: integer | null
    mín:  
    0
    máx:  
    10

    Integer numbers.

  • scrapeOptions
    Tipo: object | null
    • excludeTags
      Tipo: array string[] | null …50
    • includeTags
      Tipo: array string[] | null …50
    • maxAge
      Tipo: integer | null
      mín:  
      0
      máx:  
      31536000000

      Integer numbers.

    • minAge
      Tipo: integer | null
      mín:  
      0
      máx:  
      31536000000

      Integer numbers.

    • onlyMainContent
      Tipo: boolean | null
    • timeout
      Tipo: integer | null
      mín:  
      1000
      máx:  
      300000

      Integer numbers.

  • sitemap
    Tipo: string | null enum
    valores
    • null
    • skip
    • include
    • only
Respostas
  • 202
    Tipo: object

    Sucesso

    • completedAt
      Tipo: string | null Formato: date-time
      obrigatório

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

    • createdAt
      Tipo: string | null Formato: date-time
      obrigatório

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

    • endpoint
      Tipo: string | null
      obrigatório

      Identificador de operação do provedor; use o caminho de job documentado da Felo para o polling.

    • error
      Tipo: object | null
      obrigatório
      • code
        Tipo: string | null
      • message
        Tipo: string | null
    • id
      Tipo: string | null
      obrigatório
    • object
      const:  
      integration_async_job
      obrigatório
    • output
      obrigatório
    • pricing
      Tipo: object | null
      obrigatório

      Metadados de autorização e liquidação do provedor em micro-USD; não é saldo, retenção nem recibo de cobrança da Felo.

      • authorizedMicrosUSD
        Tipo: integer | null

        Integer numbers.

      • billingMode
        Tipo: string | null
      • currency
        Tipo: string | null
      • finalMicrosUSD
        Tipo: integer | null

        Integer numbers.

    • status
      Tipo: string enum
      obrigatório
      valores
      • queued
      • running
      • completed
      • failed
      • cancelled
    • outputExpired
      Tipo: boolean | null
    application/json
  • 400

    Não foi possível processar a requisição. Verifique os parâmetros da requisição.

  • 401

    É necessária uma chave de API da Felo válida.

  • 402

    A requisição não pode prosseguir porque um requisito de cobrança não foi atendido.

  • 403

    A conta não tem permissão para realizar esta operação.

  • 429

    Um limite de requisições ou de gastos foi atingido.

  • 502

    O serviço não pôde concluir a requisição.

  • 503

    A API ou o serviço de cobrança está temporariamente indisponível.

  • 504

    O serviço atingiu o tempo limite ao processar a requisição.

  • default

    A operação falhou. Guarde o ID de requisição da resposta ao contatar o suporte da 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.