> ## 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 web crawl job results

> Retrieves the status and results of a web crawl job. Results are paginated.



## OpenAPI

````yaml /openapi.json GET /api/web/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/web/crawl/{id}:
    get:
      summary: Get web crawl job results
      description: >-
        Retrieves the status and results of a web crawl job. Results are
        paginated.
      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: Web crawl job details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebCrawlJobResponse'
        '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 web crawl job
          source: |-
            import { Hyperbrowser } from '@hyperbrowser/sdk';

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

            const response = await client.web.crawl.get('job-id', {
              page: 0,
              batchSize: 10
            });
        - lang: python
          label: Get web crawl job
          source: |-
            from hyperbrowser import Hyperbrowser
            from hyperbrowser.models import GetWebCrawlJobParams

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

            response = client.web.crawl.get('job-id', GetWebCrawlJobParams(
              page=0,
              batch_size=10
            ))
components:
  schemas:
    WebCrawlJobResponse:
      type: object
      properties:
        jobId:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/JobStatus'
        error:
          type: string
          nullable: true
        totalPages:
          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/WebCrawlPageData'
      required:
        - status
        - jobId
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
    JobStatus:
      type: string
      enum:
        - pending
        - running
        - completed
        - failed
        - stopped
    WebCrawlPageData:
      type: object
      properties:
        url:
          type: string
        status:
          $ref: '#/components/schemas/PageStatus'
        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
        json:
          type: object
        branding:
          $ref: '#/components/schemas/BrandingProfile'
      required:
        - url
        - status
    PageStatus:
      type: string
      enum:
        - completed
        - failed
        - pending
        - running
    BrandingProfile:
      type: object
      description: >-
        Visual brand profile extracted via DOM analysis + LLM enhancement. All
        fields optional; the server may return a partial profile when the LLM
        refuses or fails.
      properties:
        colorScheme:
          type: string
          description: 'Page color scheme. Common values: light, dark.'
        colors:
          type: object
          description: >-
            Color role assignments. Common keys: primary, secondary, accent,
            background, textPrimary, textSecondary, link.
        fonts:
          type: array
          description: Cleaned brand fonts with roles.
          items:
            type: object
            properties:
              family:
                type: string
              role:
                type: string
        typography:
          type: object
          description: >-
            Font families, stacks, and sizes. Keys: fontFamilies, fontStacks,
            fontSizes, lineHeights, fontWeights.
        spacing:
          type: object
          description: >-
            Spacing scale. Common keys: baseUnit, borderRadius, padding,
            margins, gridGutter.
        components:
          type: object
          description: >-
            Per-component style dictionaries. Common keys: buttonPrimary,
            buttonSecondary, input. Each value has background, textColor,
            borderColor, borderRadius, borderRadiusCorners, shadow.
        images:
          type: object
          description: >-
            Brand images. Common keys: logo, logoHref, logoAlt, favicon,
            ogImage.
        personality:
          type: object
          description: 'Brand personality. Common keys: tone, energy, targetAudience.'
        designSystem:
          type: object
          description: 'Detected design system. Common keys: framework, componentLibrary.'
        confidence:
          type: object
          description: 'Confidence scores (0-1). Common keys: buttons, colors, overall.'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````