fastcrw-com Search API

openapi: 3.2.0
info:
  title: CRW REST Search API
  version: 0.39.1
  description: Firecrawl-compatible web scraping, crawling, mapping, search, and extraction API. Hosted at https://api.fastcrw.com; self-host with `docker run -p 3000:3000 ghcr.io/fastcrw/crw:latest`.
  license:
    name: AGPL-3.0
    url: https://opensource.org/licenses/AGPL-3.0
  contact:
    url: https://github.com/fastcrw/crw
servers:
- url: https://api.fastcrw.com
  description: Hosted (requires Bearer token)
- url: http://localhost:3000
  description: Self-hosted (no auth by default)
security:
- bearerAuth: []
- {}
tags:
- name: Search
  description: Web search via our own search backend (self-hosted) or managed (hosted)
paths:
  /v1/search:
    post:
      tags:
      - Search
      summary: Search the web and optionally scrape results
      operationId: search
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
            examples:
              minimal:
                summary: Top 3 results, no scraping
                value:
                  query: renewable energy trends 2024
                  limit: 3
              with_scrape:
                summary: Scrape each result as markdown
                value:
                  query: rust async runtime
                  limit: 5
                  scrapeOptions:
                    formats:
                    - markdown
                    onlyMainContent: true
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/SearchDisabled'
components:
  responses:
    BadRequest:
      description: Invalid request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid bearer token (hosted only)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    SearchDisabled:
      description: 'Search is disabled in self-hosted config (error: search_disabled)'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message
        errorCode:
          type: string
          description: Machine-readable error code (see docs/error-codes.md)
    SearchRequest:
      type: object
      required:
      - query
      properties:
        query:
          type: string
          minLength: 1
          maxLength: 2000
        limit:
          type: integer
          minimum: 1
          maximum: 20
          default: 5
        lang:
          type: string
          example: en
        tbs:
          type: string
          enum:
          - qdr:h
          - qdr:d
          - qdr:w
          - qdr:m
          - qdr:y
        sources:
          type: array
          items:
            type: string
            enum:
            - web
            - news
            - images
        categories:
          type: array
          items:
            type: string
        scrapeOptions:
          $ref: '#/components/schemas/SearchScrapeOptions'
    SearchResult:
      type: object
      required:
      - url
      - title
      properties:
        url:
          type: string
          format: uri
        title:
          type: string
        snippet:
          type: string
          description: Result blurb (LLM-ready summary line)
        description:
          type: string
          description: Alias of snippet (same value, kept for Firecrawl response-shape parity)
        position:
          type: integer
        score:
          type: number
        category:
          type: string
          description: Search backend result category (e.g. 'general')
        markdown:
          type: string
          description: Present when scrapeOptions.formats includes 'markdown'
    SearchResponse:
      type: object
      required:
      - success
      - data
      properties:
        success:
          type: boolean
        data:
          description: Search results. On the hosted API (https://api.fastcrw.com) the results ARE the value of `data`. A self-hosted engine wraps them one level deeper as `data.results`, and carries `answer`/`citations`/`llmUsage`/`warnings` inside `data` instead of at the top level. Clients that must work against both should read `data.results` when present and fall back to `data`.
          anyOf:
          - title: Flat results
            description: Returned when `sources` is not set.
            type: array
            items:
              $ref: '#/components/schemas/SearchResult'
          - title: Grouped results
            description: Returned when `sources` is set.
            type: object
            properties:
              web:
                type: array
                items:
                  $ref: '#/components/schemas/SearchResult'
              news:
                type: array
                items:
                  $ref: '#/components/schemas/SearchResult'
              images:
                type: array
                items:
                  type: object
          - title: Self-hosted wrapper
            description: The self-hosted engine nests the flat or grouped results under `results`.
            type: object
            required:
            - results
            properties:
              results: {}
              answer:
                type: string
              citations:
                type: array
                items:
                  type: object
              llmUsage:
                type: object
              warnings:
                type: array
                items:
                  type: string
        answer:
          type: string
          description: 'Hosted API only — synthesized answer over the top results, present when `answer: true` was set. A self-hosted engine returns this inside `data`.'
        citations:
          type: array
          description: Hosted API only — sources for `answer`, in citation order. A self-hosted engine returns this inside `data`.
          items:
            type: object
        llmUsage:
          type: object
          description: Hosted API only — token usage for the answer synthesis. A self-hosted engine returns this inside `data`.
        warnings:
          type: array
          description: Hosted API only — soft-failure notices (e.g. an answer leg that was rate-limited). A self-hosted engine returns this inside `data`.
          items:
            type: string
    SearchScrapeOptions:
      type: object
      properties:
        formats:
          type: array
          items:
            type: string
            enum:
            - markdown
            - html
            - rawHtml
            - links
          default:
          - markdown
        onlyMainContent:
          type: boolean
          default: true
        timeout:
          type: integer
          description: Per-result scrape budget in ms. Default 15000. Search awaits every result, so this bounds the whole response; raise it for heavy JS pages.
          minimum: 1
          maximum: 60000
          default: 15000
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: Hosted only. Get a key at https://fastcrw.com/register.