Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Run a web search and return ranked results.

Server:https://openapi.felo.ai
Client Libraries

Firecrawl

​

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

Firecrawl Operations

Run a web search and return ranked results.

​

Search the web and get back ranked results. query is required; limit sets how many. Returns success, creditsUsed, a request id, and data.web[] with url, title, description and position — titles and snippets only, no page text. Reach for something else when: you want the page text in the same call — searchWeb returns it and answers in a third of the time; you already know the URLs — post_firecrawl_scrape; you want relevance judged by meaning rather than keywords — post_exa_search.

Body
required
application/json
  • query
    Type: string
    max length:  
    500
    required

    The search query. Must be non-empty and at most 500 characters.

  • limit
    Type: integer
    min:  
    1
    max:  
    100

    Maximum number of results to return.

Responses
  • 200
    Type: object

    Search completed successfully.

    • creditsUsed
      Type: integer

      Firecrawl credits consumed (about 2 per 10 results).

    • data
      Type: object
      • web
        Type: array object[]

        Ranked web search results.

        • description
          Type: string

          Result snippet.

        • title
          Type: string

          Result title.

        • url
          Type: string

          Result URL.

    • success
      Type: boolean

      True when the search succeeded.

    application/json
  • 400

    The request could not be processed. Check the request parameters.

  • 401

    A valid Felo API key is required.

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    A request or spending limit has been reached.

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/firecrawl/search
curl https://openapi.felo.ai/v1/beta/firecrawl/search \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "query": "firecrawl web scraping api",
  "limit": 10
}'
{
  "success": true,
  "data": {
    "web": [
      {
        "title": "string",
        "url": "string",
        "description": "string"
      }
    ]
  },
  "creditsUsed": 1
}
Run a web search and return ranked results.