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

# Anonymous demo capture

> **Not for integration.** Powers the live "try it" widget on
scrnshot.site. No authentication; rate-limited by client IP
(5/day). Fixed PNG output at 1280×720. Use `POST /v1/screenshots`
with an API key for real usage.




## OpenAPI

````yaml /api-reference/openapi.yaml post /demo/screenshot
openapi: 3.1.0
info:
  title: scrnshot API
  version: 1.0.0
  summary: Programmatic screenshot capture for developers.
  description: |
    scrnshot renders a URL and returns a hosted image. Authenticate with an
    API key (`X-API-Key`) for the endpoints under `/v1/screenshots` and
    `/v1/usage`. API-key management (`/v1/keys`) and billing endpoints use
    dashboard session cookies instead and are documented here for
    completeness — they are not part of the programmatic integration
    surface.

    Quotas are monthly (Free: 100/mo, Pro: 5,000/mo). Independently, requests
    are rate-limited per minute (Free: 5/min, Pro: 60/min). Exceeding the
    monthly quota returns `402`; exceeding the per-minute rate limit returns
    `429`.
servers:
  - url: https://api.scrnshot.site
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Screenshots
    description: Capture, list, and delete screenshots.
  - name: Usage
    description: Quota and rate-limit consumption.
  - name: API Keys
    description: |
      Dashboard-only. Authenticated with a session cookie, not an API key —
      a key cannot be used to mint or revoke other keys.
  - name: Billing
    description: Dashboard-only. Authenticated with a session cookie.
  - name: Demo
    description: |
      Unauthenticated, IP-rate-limited endpoint that powers the live demo on
      scrnshot.site. Not intended for integration — use `/v1/screenshots`
      with an API key instead.
paths:
  /demo/screenshot:
    post:
      tags:
        - Demo
      summary: Anonymous demo capture
      description: |
        **Not for integration.** Powers the live "try it" widget on
        scrnshot.site. No authentication; rate-limited by client IP
        (5/day). Fixed PNG output at 1280×720. Use `POST /v1/screenshots`
        with an API key for real usage.
      operationId: demoScreenshot
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  example: https://example.com
              required:
                - url
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  image_url:
                    type: string
                    format: uri
                  remaining:
                    type: integer
                    description: Captures left today for this IP.
                required:
                  - image_url
                  - remaining
        '400':
          description: Missing or invalid `url`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Daily per-IP demo limit (5/day) reached.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitedResponse'
        '500':
          $ref: '#/components/responses/ServerError'
      security: []
components:
  schemas:
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
    RateLimitedResponse:
      type: object
      required:
        - message
        - success
        - limit
        - used
        - remaining
        - reset_time
      properties:
        message:
          type: string
          example: Rate limit exceeded
        success:
          type: boolean
          example: false
        limit:
          type: integer
        used:
          type: integer
        remaining:
          type: integer
        reset_time:
          type: integer
          description: Unix timestamp when the rate-limit window resets.
        plan:
          type: string
  responses:
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: |
        Programmatic auth for the `/v1/screenshots` and `/v1/usage`
        endpoints. Create a key from the dashboard (`POST /v1/keys`); the
        plaintext value is shown once at creation.

````