screenshotscout-com API

openapi: 3.1.0
info:
  title: screenshotscout-com API
  version: '2026-10-31'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-31: 3 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; screenshotscout-com has published no machine-readable contract
    that the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 2
    documentation: 1
    pages-with-code: 2
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-31'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://screenshotscout.com/docs/api-reference
  - https://screenshotscout.com/docs/quickstart
servers:
- url: https://api.screenshotscout.com
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://screenshotscout.com/docs/quickstart
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Install the package from npm: npm install @screenshotscout/sdk The SDK requires Node.js 22 or newer. Install the package\
          \ from PyPI: pip install screenshotscout The SDK requires Python 3.11 or newer. Install the package with Composer: composer require\
          \ screenshotscout/sdk The SDK requires PHP 8.3 or newer. Add the dependency to your Maven project's pom.xml : < dependency > \n < groupId\
          \ >com.scre"
  /v1/capture:
    get:
      operationId: get_v1_capture
      tags:
      - Capture
      summary: Send screenshot options as query parameters to capture a webpage.
      x-source: https://screenshotscout.com/docs/api-reference
      parameters:
      - name: access_key
        in: query
        required: false
        schema:
          type: string
        description: API access key for authentication
      - name: url
        in: query
        required: true
        schema:
          type: string
        description: The URL to capture
      - name: full_page
        in: query
        required: false
        schema:
          type: boolean
        description: Whether to capture the full page
      - name: hide_selectors
        in: query
        required: false
        schema:
          type: string
        description: CSS selectors to hide (can be repeated)
      - name: response_type
        in: query
        required: false
        schema:
          type: string
        description: Response format; set to 'json' for JSON response with screenshot URL
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1CaptureResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_capture
      tags:
      - Capture
      summary: POST /v1/capture
      x-source: https://screenshotscout.com/docs/api-reference
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1CaptureRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1CaptureResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl \"https://api.screenshotscout.com/v1/capture\"  -H \"Authorization: Bearer YOUR_ACCESS_KEY\"  -H \"Content-Type: application/json\"\
          \  -d '{ \n \"url\": \"https://example.com/\", \n \"full_page\": true, \n \"hide_selectors\": [\".cookie-banner\", \"#ad-overlay\"]\
          \ \n }'  -o \"screenshot.png\" \n For POST requests, we ignore query parameters, so put every option in the body. \n GET \n Send the\
          \ screenshot options as query p"
components:
  schemas:
    GetV1CaptureResponse:
      type: object
      properties:
        screenshot_url:
          type: string
          description: Temporary URL of the screenshot when response_type is json
        error_code:
          type: string
          description: Machine-readable error code on failure
        error_message:
          type: string
          description: Descriptive error message on failure
        errors:
          type: array
          description: Array of detailed errors (present only for invalid_options error code)
    PostV1CaptureRequest:
      type: object
      properties:
        url:
          type: string
        full_page:
          type: boolean
        hide_selectors:
          type: array
          items:
            type: string
    PostV1CaptureResponse:
      type: object
      properties:
        screenshot_url:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Capture