abstract-api/openapi/abstract-api-website-screenshot.yaml at main · api-evangelist/abstract-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
openapi: 3.0.3
info:
  title: Abstract API - Website Screenshot API
  description: Capture high-quality screenshots of any website with optional customizations including CSS injection, delay settings, and viewport configuration.
  version: 1.0.0
  contact:
    url: https://www.abstractapi.com/
  x-generated-from: documentation
servers:
  - url: https://screenshot.abstractapi.com/v1
    description: Website Screenshot API v1
security:
  - apiKey: []
tags:
  - name: Website Screenshot
    description: Website screenshot capture operations
paths:
  /:
    get:
      operationId: captureWebsiteScreenshot
      summary: Abstract API Capture Website Screenshot
      description: Capture a screenshot of any website URL with configurable viewport, delay, and CSS injection options.
      tags:
        - Website Screenshot
      parameters:
        - name: api_key
          in: query
          required: true
          description: Your unique API key for the Website Screenshot API.
          schema:
            type: string
          example: abc123def456
        - name: url
          in: query
          required: true
          description: The URL of the website to screenshot.
          schema:
            type: string
            format: uri
          example: https://www.example.com
        - name: capture_full_page
          in: query
          required: false
          description: Whether to capture the full scrollable page. Defaults to false.
          schema:
            type: boolean
          example: false
        - name: width
          in: query
          required: false
          description: Viewport width in pixels. Defaults to 1280.
          schema:
            type: integer
          example: 1280
        - name: height
          in: query
          required: false
          description: Viewport height in pixels. Defaults to 720.
          schema:
            type: integer
          example: 720
        - name: delay
          in: query
          required: false
          description: Delay in milliseconds before taking the screenshot.
          schema:
            type: integer
          example: 1000
        - name: css_injection
          in: query
          required: false
          description: CSS string to inject into the page before screenshotting.
          schema:
            type: string
          example: 'body { background: white; }'
        - name: export_format
          in: query
          required: false
          description: Output format of the screenshot (jpeg or png). Defaults to jpeg.
          schema:
            type: string
            enum:
              - jpeg
              - png
          example: jpeg
      responses:
        '200':
          description: Screenshot image binary
          content:
            image/jpeg:
              schema:
                type: string
                format: binary
            image/png:
              schema:
                type: string
                format: binary
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: api_key
  schemas:
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          example: The provided API key is invalid
        error:
          type: string
          example: invalid_api_key