shotkit-net API

openapi: 3.1.0
info:
  title: shotkit-net API
  version: '2026-10-31'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-31: 2 operation(s) read from 40 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; shotkit-net has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 1
    pages-with-code: 40
    pages-read: 40
  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: local
  x-sources:
  - https://shotkit.net/docs/quickstart
  - https://shotkit.net/docs/options/clip
  - https://shotkit.net/docs/options/async
  - https://shotkit.net/docs/quickstart.md
  - https://shotkit.net/docs/options/clip.md
  - https://shotkit.net/use-cases/url-to-pdf
  - https://shotkit.net/docs/options/async.md
  - https://shotkit.net/use-cases/html-to-pdf
  - https://shotkit.net/use-cases/chart-images
  - https://shotkit.net/docs/async-and-webhooks
  - https://shotkit.net/use-cases/html-to-image
  - https://shotkit.net/use-cases/link-previews
  - https://shotkit.net/use-cases/website-videos
  - https://shotkit.net/docs/async-and-webhooks.md
  - https://shotkit.net/use-cases/code-screenshots
  - https://shotkit.net/use-cases/website-thumbnails
  - https://shotkit.net/use-cases/og-image-generation
  - https://shotkit.net/use-cases/social-media-images
  - https://shotkit.net/use-cases/website-to-markdown
  - https://shotkit.net/use-cases/certificate-generation
  - https://shotkit.net/use-cases/visual-regression-testing
  - https://shotkit.net/docs/authentication
  - https://shotkit.net/docs/html-and-markdown
  - https://shotkit.net/docs/full-page
  - https://shotkit.net/docs/clean-screenshots
  - https://shotkit.net/docs/pdf
  - https://shotkit.net/docs/video
  - https://shotkit.net/docs/responses
  - https://shotkit.net/docs/caching
  - https://shotkit.net/docs/ai-agents
  - https://shotkit.net/docs/options/essentials
  - https://shotkit.net/docs/options/viewport
  - https://shotkit.net/docs/options/image
  - https://shotkit.net/docs/options/full-page
  - https://shotkit.net/docs/options/pdf
  - https://shotkit.net/docs/options/animation
  - https://shotkit.net/docs/options/emulation
  - https://shotkit.net/docs/options/customization
  - https://shotkit.net/docs/options/blocking
  - https://shotkit.net/docs/options/wait
paths:
  /api/take:
    get:
      operationId: get_api_take
      tags:
      - Api
      summary: Take a screenshot by sending the page URL and optional format, with the access key in a header or query string.
      description: The response body is the image file. With no other options you get a 1280×1024 screenshot of the viewport after the page has
        loaded.
      x-source: https://shotkit.net/docs/quickstart
      parameters:
      - name: access_key
        in: query
        required: true
        schema:
          type: string
        description: Your API access key (alternatively sent in the X-Access-Key header).
      - name: url
        in: query
        required: true
        schema:
          type: string
        description: The web page URL to screenshot.
      - name: format
        in: query
        required: false
        schema:
          type: string
        description: Image format, e.g., "png".
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_take
      tags:
      - Api
      summary: POST /api/take
      x-source: https://shotkit.net/docs/quickstart
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiTakeRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js Python Go Ruby PHP Java C# Kotlin Rust Swift Elixir GET URL curl -X POST "https://shotkit.net/api/take"  -H "X-Access-Key:
          YOUR_ACCESS_KEY"  -H "Content-Type: application/json"  -d ''{"url":"https://example.com","format":"png"}''  --fail-with-body -o shot.png
          Replace YOUR_ACCESS_KEY with your key. With no other options you get a 1280×1024 screenshot of the viewport after the page has lo'
components:
  schemas:
    PostApiTakeRequest:
      type: object
      properties:
        url:
          type: string
        format:
          type: string
  securitySchemes:
    X-Access-Key:
      type: apiKey
      in: header
      name: Authorization
      x-source: https://shotkit.net/docs/authentication.md
    access_key:
      type: apiKey
      in: header
      name: Authorization
      x-source: https://shotkit.net/docs/authentication.md
tags:
- name: Api
security:
- X-Access-Key: []
- access_key: []