> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beecrawl.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Start a batch scrape



## OpenAPI

````yaml /docs/openapi.yaml post /batch/scrape
openapi: 3.0.3
info:
  title: BeeCrawl API
  version: 0.1.0
  description: Self-hostable web scraping, crawling, search, and extraction API.
servers:
  - url: https://api.beecrawl.dev
    description: BeeCrawl hosted deployment
  - url: http://127.0.0.1:8000
    description: Local development
security:
  - apiKey: []
tags:
  - name: Scraping
  - name: Discovery
  - name: Async jobs
  - name: Search
  - name: Extraction
paths:
  /batch/scrape:
    post:
      tags:
        - Async jobs
      summary: Start a batch scrape
      operationId: createBatchScrape
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchScrapeRequest'
      responses:
        '200':
          description: Batch scrape job created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchScrapeEnqueueResponse'
components:
  schemas:
    BatchScrapeRequest:
      type: object
      required:
        - urls
      properties:
        urls:
          type: array
          minItems: 1
          items:
            type: string
            format: uri
        timeout_seconds:
          type: integer
          default: 30
        wait_for_ms:
          type: integer
          default: 0
        use_browser:
          type: string
          enum:
            - never
            - auto
            - always
          default: auto
        maxRetries:
          type: integer
          default: 2
    BatchScrapeEnqueueResponse:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
        total:
          type: integer
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Web-Extract-Api-Key
      description: API key. X-Api-Key and Bearer authentication are also accepted.

````