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

# Take a screenshot

> Return a JPEG of the current desktop from the host's last-frame
buffer (DXGI capture, not VNC). Capture is always native resolution
(including 4K). Use `max_width` / `quality` to downscale on the host
for faster LLM ingest. Response headers include both JPEG size and
native desktop size for click coordinate mapping.




## OpenAPI

````yaml /openapi.yaml get /v1/sessions/{sessionId}/screenshot
openapi: 3.1.0
info:
  title: Glasswarp Platform API
  version: 1.0.0
  description: >
    Real-time visual access and native input control on Windows machines.

    See any screen. Control any PC. One API.


    ## Authentication


    All `/v1/*` endpoints require a bearer token:


    ```

    Authorization: Bearer gw_live_sk_...

    ```


    API keys are created in the [Console](/console/keys).

    Keys are scoped to your account and can access any rig with API access
    enabled.


    ## Base URL


    `https://signal.glasswarp.com`
  contact:
    name: Glasswarp
    url: https://glasswarp.com
  license:
    name: Proprietary
servers:
  - url: https://signal.glasswarp.com
    description: Production
security:
  - apiKey: []
paths:
  /v1/sessions/{sessionId}/screenshot:
    get:
      tags:
        - Screenshots
      summary: Take a screenshot
      description: |
        Return a JPEG of the current desktop from the host's last-frame
        buffer (DXGI capture, not VNC). Capture is always native resolution
        (including 4K). Use `max_width` / `quality` to downscale on the host
        for faster LLM ingest. Response headers include both JPEG size and
        native desktop size for click coordinate mapping.
      operationId: takeScreenshot
      parameters:
        - name: sessionId
          in: path
          required: true
          schema:
            type: string
        - name: max_width
          in: query
          required: false
          schema:
            type: integer
            example: 1280
          description: Long-edge cap for the returned JPEG (native capture unchanged)
        - name: quality
          in: query
          required: false
          schema:
            type: integer
            minimum: 40
            maximum: 100
            default: 85
          description: JPEG quality
        - name: x
          in: query
          required: false
          schema:
            type: integer
          description: ROI crop origin X (native capture coords, VP0)
        - name: 'y'
          in: query
          required: false
          schema:
            type: integer
          description: ROI crop origin Y
        - name: w
          in: query
          required: false
          schema:
            type: integer
          description: ROI crop width
        - name: h
          in: query
          required: false
          schema:
            type: integer
          description: ROI crop height
      responses:
        '200':
          description: JPEG screenshot
          headers:
            X-Screenshot-Width:
              schema:
                type: integer
              description: Width of the returned JPEG
            X-Screenshot-Height:
              schema:
                type: integer
              description: Height of the returned JPEG
            X-Screenshot-Native-Width:
              schema:
                type: integer
              description: Native desktop capture width (use for clicks)
            X-Screenshot-Native-Height:
              schema:
                type: integer
              description: Native desktop capture height (use for clicks)
          content:
            image/jpeg:
              schema:
                type: string
                format: binary
        '504':
          description: Screenshot timed out (host did not respond within 5s)
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: API key in the format `gw_(live|test)_sk_<hex>`

````