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

# Get crawl job status and results



## OpenAPI

````yaml /openapi.json GET /api/crawl/{id}
openapi: 3.0.1
info:
  title: Hyperbrowser API
  version: 1.0.0
servers:
  - url: https://api.hyperbrowser.ai
    description: Production server
security: []
paths:
  /api/crawl/{id}:
    get:
      summary: Get crawl job status and results
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
        - name: batchSize
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
      responses:
        '200':
          description: Crawl job details retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  jobId:
                    type: string
                    format: uuid
                  status:
                    $ref: '#/components/schemas/JobStatus'
                  error:
                    type: string
                    nullable: true
                  totalCrawledPages:
                    type: integer
                    minimum: 0
                  totalPageBatches:
                    type: integer
                    minimum: 0
                  currentPageBatch:
                    type: integer
                    minimum: 0
                  batchSize:
                    type: integer
                    minimum: 1
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CrawledPage'
                required:
                  - status
                  - jobId
        '404':
          description: Crawl job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: javascript
          label: Get crawl job
          source: |-
            import { Hyperbrowser } from '@hyperbrowser/sdk';

            const client = new Hyperbrowser({ apiKey: 'your-api-key' });

            await client.crawl.get('job-id', {
              page: 1
            });
        - lang: python
          label: Get crawl job
          source: |-
            from hyperbrowser import Hyperbrowser
            from hyperbrowser.models import GetCrawlJobParams

            client = Hyperbrowser(api_key='your-api-key')

            client.crawl.get('job-id', GetCrawlJobParams(
              page=1
            ))
components:
  schemas:
    JobStatus:
      type: string
      enum:
        - pending
        - running
        - completed
        - failed
        - stopped
    CrawledPage:
      type: object
      properties:
        url:
          type: string
        status:
          type: string
          enum:
            - completed
            - failed
        error:
          type: string
          nullable: true
        metadata:
          type: object
          additionalProperties:
            oneOf:
              - type: string
              - type: array
                items:
                  type: string
        markdown:
          type: string
        html:
          type: string
        links:
          type: array
          items:
            type: string
        screenshot:
          type: string
      required:
        - url
        - status
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````