Website Screenshot Generator
Try for free
No credit card required
Go to Store
Website Screenshot Generator
apify/screenshot-url
Try for free
No credit card required
Create a screenshot of a website based on a specified URL. The screenshot is stored as the output in a key-value store. It can be used to monitor web changes regularly after setting up the scheduler.
You can access the Website Screenshot Generator programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
1{
2 "openapi": "3.0.1",
3 "info": {
4 "version": "0.0",
5 "x-build-id": "IPzSK7D0Y8CDS90ix"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/apify~screenshot-url/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-apify-screenshot-url",
16 "x-openai-isConsequential": false,
17 "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18 "tags": [
19 "Run Actor"
20 ],
21 "requestBody": {
22 "required": true,
23 "content": {
24 "application/json": {
25 "schema": {
26 "$ref": "#/components/schemas/inputSchema"
27 }
28 }
29 }
30 },
31 "parameters": [
32 {
33 "name": "token",
34 "in": "query",
35 "required": true,
36 "schema": {
37 "type": "string"
38 },
39 "description": "Enter your Apify token here"
40 }
41 ],
42 "responses": {
43 "200": {
44 "description": "OK"
45 }
46 }
47 }
48 },
49 "/acts/apify~screenshot-url/runs": {
50 "post": {
51 "operationId": "runs-sync-apify-screenshot-url",
52 "x-openai-isConsequential": false,
53 "summary": "Executes an Actor and returns information about the initiated run in response.",
54 "tags": [
55 "Run Actor"
56 ],
57 "requestBody": {
58 "required": true,
59 "content": {
60 "application/json": {
61 "schema": {
62 "$ref": "#/components/schemas/inputSchema"
63 }
64 }
65 }
66 },
67 "parameters": [
68 {
69 "name": "token",
70 "in": "query",
71 "required": true,
72 "schema": {
73 "type": "string"
74 },
75 "description": "Enter your Apify token here"
76 }
77 ],
78 "responses": {
79 "200": {
80 "description": "OK",
81 "content": {
82 "application/json": {
83 "schema": {
84 "$ref": "#/components/schemas/runsResponseSchema"
85 }
86 }
87 }
88 }
89 }
90 }
91 },
92 "/acts/apify~screenshot-url/run-sync": {
93 "post": {
94 "operationId": "run-sync-apify-screenshot-url",
95 "x-openai-isConsequential": false,
96 "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97 "tags": [
98 "Run Actor"
99 ],
100 "requestBody": {
101 "required": true,
102 "content": {
103 "application/json": {
104 "schema": {
105 "$ref": "#/components/schemas/inputSchema"
106 }
107 }
108 }
109 },
110 "parameters": [
111 {
112 "name": "token",
113 "in": "query",
114 "required": true,
115 "schema": {
116 "type": "string"
117 },
118 "description": "Enter your Apify token here"
119 }
120 ],
121 "responses": {
122 "200": {
123 "description": "OK"
124 }
125 }
126 }
127 }
128 },
129 "components": {
130 "schemas": {
131 "inputSchema": {
132 "type": "object",
133 "required": [
134 "waitUntil",
135 "delay",
136 "viewportWidth"
137 ],
138 "properties": {
139 "urls": {
140 "title": "List of URLs",
141 "type": "array",
142 "description": "List of URLs you want to take screenshots of.",
143 "items": {
144 "type": "object",
145 "required": [
146 "url"
147 ],
148 "properties": {
149 "url": {
150 "type": "string",
151 "title": "URL of a web page",
152 "format": "uri"
153 }
154 }
155 }
156 },
157 "format": {
158 "title": "Format",
159 "enum": [
160 "png",
161 "pdf"
162 ],
163 "type": "string",
164 "description": "Screenshot file format.",
165 "default": "png"
166 },
167 "waitUntil": {
168 "title": "Wait until",
169 "enum": [
170 "load",
171 "domcontentloaded",
172 "networkidle2",
173 "networkidle0"
174 ],
175 "type": "string",
176 "description": "Control's when will the browser take a screenshot"
177 },
178 "delay": {
179 "title": "Delay before screenshot",
180 "minimum": 0,
181 "maximum": 3600000,
182 "type": "integer",
183 "description": "Add's delay before a screenshot is taken. Minimum is 0, maximum is 5 minutes (3600000ms)",
184 "default": 0
185 },
186 "viewportWidth": {
187 "title": "Width",
188 "minimum": 100,
189 "maximum": 3840,
190 "type": "integer",
191 "description": "How wide should the website's viewport be",
192 "default": 1280
193 },
194 "scrollToBottom": {
195 "title": "Scroll to bottom",
196 "type": "boolean",
197 "description": "Should the browser scroll to the bottom of the page before taking a screenshot",
198 "default": false
199 },
200 "delayAfterScrolling": {
201 "title": "Delay After Scrolling",
202 "minimum": 0,
203 "maximum": 3600000,
204 "type": "integer",
205 "description": "Specify the delay (in milliseconds) after scrolling to the bottom of the page before taking the screenshot. This option is only used if 'Wait for Network Idle After Scrolling' is not enabled.",
206 "default": 2500
207 },
208 "waitUntilNetworkIdleAfterScroll": {
209 "title": "Wait for Network Idle After Scrolling (Overrides \"Delay After Scrolling\" option)",
210 "type": "boolean",
211 "description": "Choose whether to wait for the network to become idle after scrolling to the bottom of the page before taking a screenshot. If enabled, this option overrides the 'Delay After Scrolling' option.",
212 "default": false
213 },
214 "waitUntilNetworkIdleAfterScrollTimeout": {
215 "title": "Network Idle Timeout",
216 "minimum": 1000,
217 "maximum": 3600000,
218 "type": "integer",
219 "description": "Specify the maximum wait time (in milliseconds) for the network to become idle after scrolling to the bottom of the page before taking the screenshot, this option is used to make sure handler doesn't get stuck for some pages. This option is only used if 'Wait for Network Idle After Scrolling' is enabled.",
220 "default": 30000
221 },
222 "proxy": {
223 "title": "Proxy configuration",
224 "type": "object",
225 "description": "Set the proxy configuration of the scraper",
226 "default": {
227 "useApifyProxy": true
228 }
229 },
230 "selectorsToHide": {
231 "title": "Selectors to hide",
232 "type": "string",
233 "description": "List of selectors to hide before taking a screenshot",
234 "default": ""
235 }
236 }
237 },
238 "runsResponseSchema": {
239 "type": "object",
240 "properties": {
241 "data": {
242 "type": "object",
243 "properties": {
244 "id": {
245 "type": "string"
246 },
247 "actId": {
248 "type": "string"
249 },
250 "userId": {
251 "type": "string"
252 },
253 "startedAt": {
254 "type": "string",
255 "format": "date-time",
256 "example": "2025-01-08T00:00:00.000Z"
257 },
258 "finishedAt": {
259 "type": "string",
260 "format": "date-time",
261 "example": "2025-01-08T00:00:00.000Z"
262 },
263 "status": {
264 "type": "string",
265 "example": "READY"
266 },
267 "meta": {
268 "type": "object",
269 "properties": {
270 "origin": {
271 "type": "string",
272 "example": "API"
273 },
274 "userAgent": {
275 "type": "string"
276 }
277 }
278 },
279 "stats": {
280 "type": "object",
281 "properties": {
282 "inputBodyLen": {
283 "type": "integer",
284 "example": 2000
285 },
286 "rebootCount": {
287 "type": "integer",
288 "example": 0
289 },
290 "restartCount": {
291 "type": "integer",
292 "example": 0
293 },
294 "resurrectCount": {
295 "type": "integer",
296 "example": 0
297 },
298 "computeUnits": {
299 "type": "integer",
300 "example": 0
301 }
302 }
303 },
304 "options": {
305 "type": "object",
306 "properties": {
307 "build": {
308 "type": "string",
309 "example": "latest"
310 },
311 "timeoutSecs": {
312 "type": "integer",
313 "example": 300
314 },
315 "memoryMbytes": {
316 "type": "integer",
317 "example": 1024
318 },
319 "diskMbytes": {
320 "type": "integer",
321 "example": 2048
322 }
323 }
324 },
325 "buildId": {
326 "type": "string"
327 },
328 "defaultKeyValueStoreId": {
329 "type": "string"
330 },
331 "defaultDatasetId": {
332 "type": "string"
333 },
334 "defaultRequestQueueId": {
335 "type": "string"
336 },
337 "buildNumber": {
338 "type": "string",
339 "example": "1.0.0"
340 },
341 "containerUrl": {
342 "type": "string"
343 },
344 "usage": {
345 "type": "object",
346 "properties": {
347 "ACTOR_COMPUTE_UNITS": {
348 "type": "integer",
349 "example": 0
350 },
351 "DATASET_READS": {
352 "type": "integer",
353 "example": 0
354 },
355 "DATASET_WRITES": {
356 "type": "integer",
357 "example": 0
358 },
359 "KEY_VALUE_STORE_READS": {
360 "type": "integer",
361 "example": 0
362 },
363 "KEY_VALUE_STORE_WRITES": {
364 "type": "integer",
365 "example": 1
366 },
367 "KEY_VALUE_STORE_LISTS": {
368 "type": "integer",
369 "example": 0
370 },
371 "REQUEST_QUEUE_READS": {
372 "type": "integer",
373 "example": 0
374 },
375 "REQUEST_QUEUE_WRITES": {
376 "type": "integer",
377 "example": 0
378 },
379 "DATA_TRANSFER_INTERNAL_GBYTES": {
380 "type": "integer",
381 "example": 0
382 },
383 "DATA_TRANSFER_EXTERNAL_GBYTES": {
384 "type": "integer",
385 "example": 0
386 },
387 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
388 "type": "integer",
389 "example": 0
390 },
391 "PROXY_SERPS": {
392 "type": "integer",
393 "example": 0
394 }
395 }
396 },
397 "usageTotalUsd": {
398 "type": "number",
399 "example": 0.00005
400 },
401 "usageUsd": {
402 "type": "object",
403 "properties": {
404 "ACTOR_COMPUTE_UNITS": {
405 "type": "integer",
406 "example": 0
407 },
408 "DATASET_READS": {
409 "type": "integer",
410 "example": 0
411 },
412 "DATASET_WRITES": {
413 "type": "integer",
414 "example": 0
415 },
416 "KEY_VALUE_STORE_READS": {
417 "type": "integer",
418 "example": 0
419 },
420 "KEY_VALUE_STORE_WRITES": {
421 "type": "number",
422 "example": 0.00005
423 },
424 "KEY_VALUE_STORE_LISTS": {
425 "type": "integer",
426 "example": 0
427 },
428 "REQUEST_QUEUE_READS": {
429 "type": "integer",
430 "example": 0
431 },
432 "REQUEST_QUEUE_WRITES": {
433 "type": "integer",
434 "example": 0
435 },
436 "DATA_TRANSFER_INTERNAL_GBYTES": {
437 "type": "integer",
438 "example": 0
439 },
440 "DATA_TRANSFER_EXTERNAL_GBYTES": {
441 "type": "integer",
442 "example": 0
443 },
444 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
445 "type": "integer",
446 "example": 0
447 },
448 "PROXY_SERPS": {
449 "type": "integer",
450 "example": 0
451 }
452 }
453 }
454 }
455 }
456 }
457 }
458 }
459 }
460}Website Screenshot Generator - Screenshot URL OpenAPI definition
OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Website Screenshot Generator from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients:
Developer
Apify Maintained by Apify
Actor Metrics
157 monthly users
-
64 bookmarks
>99% runs succeeded
38 days response time
Created in Nov 2018
Modified 2 months ago
Categories
