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

# Initiate a web crawl

> Starts crawling a given domain, discovering and processing internal links



## OpenAPI

````yaml https://api.askmy.biz/openapi post /crawl
openapi: 3.0.0
info:
  title: AskMyBiz API
  version: 1.0.0
  license:
    name: Private
    url: https://askmy.biz
  description: >
    API for initiating web crawls, storing content as embeddings, and performing
    vector queries

    for Q&A and structured data extraction.
servers:
  - url: https://api.askmy.biz
security:
  - ApiKeyAuth: []
paths:
  /crawl:
    post:
      summary: Initiate a web crawl
      description: >-
        Starts crawling a given domain, discovering and processing internal
        links
      operationId: initiateCrawl
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrawlRequest'
      responses:
        '200':
          description: Crawl job successfully initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrawlResponse'
components:
  schemas:
    CrawlRequest:
      type: object
      required:
        - base_url
      properties:
        base_url:
          type: string
          description: The base domain to crawl
          example: https://example.com
        namespace:
          type: string
          description: Stable identifier for this domain's vector data
          example: example_com
        max_pages:
          type: integer
          description: Maximum number of pages to process
          default: 1
    CrawlResponse:
      type: object
      properties:
        job_id:
          type: string
          example: 645f3c1649ec746bc1871307
        namespace:
          type: string
          example: example_com
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication

````