screenshotline-com API

openapi: 3.1.0
info:
  title: screenshotline-com API
  version: '2026-10-31'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-31: 3 operation(s) read from 28 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; screenshotline-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: 28
    pages-read: 28
  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://screenshotline.com/url-to-image-api
  - https://screenshotline.com/html-to-image-api
  - https://screenshotline.com/website-screenshot-api
  - https://screenshotline.com/docs/curl
  - https://api.screenshotline.com
  - https://screenshotline.com/docs/go
  - https://screenshotline.com/docs/node
  - https://screenshotline.com/docs/python
  - https://screenshotline.com/docs
  - https://screenshotline.com/docs/extract
  - https://api.screenshotline.com/docs
  - https://api.screenshotline.com/docs/extract
  - https://api.screenshotline.com/docs/curl
  - https://api.screenshotline.com/docs/node
  - https://api.screenshotline.com/docs/python
  - https://api.screenshotline.com/docs/go
  - https://screenshotline.com/use-cases/archiving-pages-for-compliance
  - https://screenshotline.com/use-cases/link-previews
  - https://screenshotline.com/use-cases/monitoring-competitor-pages
  - https://screenshotline.com/use-cases/pdf-from-html
  - https://screenshotline.com/use-cases/screenshots-for-ai-agents
  - https://screenshotline.com/use-cases/visual-regression-testing
  - https://api.screenshotline.com/use-cases/archiving-pages-for-compliance
  - https://api.screenshotline.com/use-cases/link-previews
  - https://api.screenshotline.com/use-cases/monitoring-competitor-pages
  - https://api.screenshotline.com/use-cases/pdf-from-html
  - https://api.screenshotline.com/use-cases/screenshots-for-ai-agents
  - https://api.screenshotline.com/use-cases/visual-regression-testing
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://screenshotline.com/docs/go
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Node.js Python PHP Go Markdown \n Quickstart \n Written carefully but not executed on our side — we had no Go runtime on\
          \ the machine that wrote it. If it misbehaves, tell us and we will fix it the same day. \n package main\nimport (\n \"encoding/json\"\
          \n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"os\"\n)\nfunc main() {\n q := url.Values{}\n q.Set(\"url\", \"https://example.com\"\
          )\n q.Set(\"access_key\", os.Getenv(\"SCR"
  /extract:
    get:
      operationId: get_extract
      tags:
      - Extract
      summary: Extract the rendered page as Markdown text instead of a screenshot.
      x-source: https://api.screenshotline.com
      parameters:
      - name: url
        in: query
        required: true
        schema:
          type: string
        description: http or https. Private and reserved addresses are refused.
      - name: full_page
        in: query
        required: false
        schema:
          type: boolean
        description: Capture the whole document. Scrolls first so lazy images load.
      - name: selector
        in: query
        required: false
        schema:
          type: string
        description: Capture one element instead of the viewport.
      - name: viewport_width
        in: query
        required: false
        schema:
          type: integer
        description: Defaults 1280×800.
      - name: viewport_height
        in: query
        required: false
        schema:
          type: integer
        description: Defaults 1280×800.
      - name: device_scale_factor
        in: query
        required: false
        schema:
          type: integer
        description: 2 for retina output.
      - name: block_ads
        in: query
        required: false
        schema:
          type: boolean
        description: Blocks the networks and sweeps leftover overlays.
      - name: block_cookie_banners
        in: query
        required: false
        schema:
          type: boolean
        description: Blocks the networks and sweeps leftover overlays.
      - name: delay
        in: query
        required: false
        schema:
          type: integer
        description: Extra wait in ms before capture, max 10000.
      - name: wait_until
        in: query
        required: false
        schema:
          type: string
        description: domcontentloaded (default), load, networkidle0, networkidle2. The default is deliberate — see the docs.
      - name: cache
        in: query
        required: false
        schema:
          type: boolean
        description: Serve from the store when warm.
      - name: cache_ttl
        in: query
        required: false
        schema:
          type: integer
        description: TTL in seconds.
      - name: access_key
        in: query
        required: false
        schema:
          type: string
        description: Or the X-Access-Key header.
      - name: signature
        in: query
        required: false
        schema:
          type: string
        description: HMAC of the sorted query. Required for browser-visible URLs.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExtractResponse'
      x-evidence:
        kind: documentation
  /take:
    get:
      operationId: get_take
      tags:
      - Take
      summary: GET /take
      x-source: https://screenshotline.com/url-to-image-api
      parameters:
      - name: access_key
        in: query
        required: false
        schema:
          type: string
      - name: url
        in: query
        required: false
        schema:
          type: string
      - name: viewport_width
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl -o out.png "https://api.screenshotline.com/take?url=https%3A%2F%2Fexample.com&viewport_width=1440&access_key=KEY"
components:
  schemas:
    GetResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    GetExtractResponse:
      type: object
      properties:
        text:
          type: string
          description: The rendered page content as Markdown
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Access-Key
security:
- apiKey: []
tags:
- name: Api
- name: Extract
- name: Take