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

# Page Screenshot API

> A PNG screenshot of a page as rendered right now.



## OpenAPI

````yaml openapi.json GET /v1/screenshots/pages
openapi: 3.0.0
info:
  title: ScoutLayer API
  version: 1.0.0
  description: Competitor data. One API.
servers:
  - url: https://api.scoutlayer.io
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
paths:
  /v1/screenshots/pages:
    get:
      tags:
        - screenshots
      summary: Get an on-demand screenshot of a page
      description: A PNG screenshot of a page as rendered right now.
      parameters:
        - schema:
            type: string
            format: uri
            example: https://shopify.com/pricing
          required: true
          name: url
          in: query
        - schema:
            type: boolean
            nullable: true
            description: >-
              Capture the full scrollable page instead of just the viewport
              (default false)
          required: false
          description: >-
            Capture the full scrollable page instead of just the viewport
            (default false)
          name: fullPage
          in: query
      responses:
        '200':
          description: Get an on-demand screenshot of a page
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageScreenshot'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Insufficient credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '501':
          description: This endpoint is declared but not yet implemented — never charged
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: The orchestrator failed or was unreachable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    PageScreenshot:
      type: object
      properties:
        url:
          type: string
        finalUrl:
          type: string
          description: The URL actually captured, after any redirects
        imageBase64:
          type: string
          description: PNG image, base64-encoded
        fullPage:
          type: boolean
        capturedAt:
          type: string
      required:
        - url
        - finalUrl
        - imageBase64
        - fullPage
        - capturedAt
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key passed as the X-API-Key request header. Recommended for
        server-to-server calls.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key (or OAuth token) passed as a Bearer token in the Authorization
        header.

````