> ## 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.

# Get crawl job status

> Retrieves the current status of a crawl job, including progress statistics



## OpenAPI

````yaml https://api.askmy.biz/openapi get /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:
    get:
      summary: Get crawl job status
      description: >-
        Retrieves the current status of a crawl job, including progress
        statistics
      operationId: getCrawlStatus
      parameters:
        - name: job_id
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Crawl status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrawlStatus'
components:
  schemas:
    CrawlStatus:
      type: object
      properties:
        job_id:
          type: string
          description: Unique identifier for the crawl job
          example: 645f3c1649ec746bc1871307
        namespace:
          type: string
          description: Stable identifier for this domain's vector data
          example: example_com
        base_url:
          type: string
          description: The base domain that was crawled
          example: https://example.com
        max_pages:
          type: integer
          description: Maximum number of pages to process
        status:
          type: string
          description: Current status of the crawl job
          enum:
            - pending
            - in_progress
            - failed
            - finished
        created_at:
          type: string
          description: Creation timestamp of the crawl job, in UTC
          format: date-time
          example: '2020-12-21T12:00:00Z'
        updated_at:
          type: string
          description: Last update timestamp of the crawl job, in UTC
          format: date-time
          example: '2020-12-22T12:00:00Z'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication

````