-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathsnaprender-postman-collection.json
More file actions
758 lines (758 loc) · 21.4 KB
/
snaprender-postman-collection.json
File metadata and controls
758 lines (758 loc) · 21.4 KB
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
{
"info": {
"name": "SnapRender API",
"description": "Screenshot any website via API. Supports PNG, JPEG, WebP, and PDF output with device emulation, dark mode, ad blocking, and cookie banner removal.\n\n**Base URL:** `https://app.snap-render.com`\n\n**Authentication:** Pass your API key in the `X-API-Key` header.\n\n**Get a free API key:** https://app.snap-render.com/auth/signup (50 free screenshots/month, no credit card required)\n\n**Documentation:** https://app.snap-render.com\n\n**SDKs:**\n- Node.js: `npm install snaprender`\n- Python: `pip install snaprender`",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "X-API-Key",
"type": "string"
},
{
"key": "value",
"value": "{{api_key}}",
"type": "string"
},
{
"key": "in",
"value": "header",
"type": "string"
}
]
},
"variable": [
{
"key": "base_url",
"value": "https://app.snap-render.com",
"type": "string"
},
{
"key": "api_key",
"value": "YOUR_API_KEY",
"type": "string"
}
],
"item": [
{
"name": "Screenshot",
"item": [
{
"name": "Take Screenshot (PNG)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/screenshot?url=https://example.com&format=png&width=1280&height=800",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot"],
"query": [
{
"key": "url",
"value": "https://example.com",
"description": "Required. The URL to capture."
},
{
"key": "format",
"value": "png",
"description": "Output format: png, jpeg, webp, or pdf. Default: png."
},
{
"key": "width",
"value": "1280",
"description": "Viewport width in pixels (320-3840). Default: 1280."
},
{
"key": "height",
"value": "800",
"description": "Viewport height in pixels (200-10000). Default: 800."
}
]
},
"description": "Capture a basic PNG screenshot of a website."
}
},
{
"name": "Screenshot from HTML (POST)",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"html\": \"<html><body><h1>Hello World</h1><p>Rendered from raw HTML.</p></body></html>\",\n \"format\": \"png\",\n \"width\": 800,\n \"height\": 600\n}"
},
"url": {
"raw": "{{base_url}}/v1/screenshot",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot"]
},
"description": "Render raw HTML content and capture as a screenshot. Uses POST with JSON body."
}
},
{
"name": "Screenshot from Markdown (POST)",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"markdown\": \"# Hello World\\n\\nThis is **bold** and this is `code`.\\n\\n```js\\nconsole.log(42);\\n```\",\n \"format\": \"png\",\n \"width\": 800,\n \"height\": 600\n}"
},
"url": {
"raw": "{{base_url}}/v1/screenshot",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot"]
},
"description": "Render Markdown content with a styled template and capture as a screenshot. Uses POST with JSON body."
}
},
{
"name": "Screenshot URL via POST",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"url\": \"https://example.com\",\n \"format\": \"png\",\n \"width\": 1280,\n \"height\": 800,\n \"dark_mode\": true\n}"
},
"url": {
"raw": "{{base_url}}/v1/screenshot",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot"]
},
"description": "Capture a URL screenshot using POST with JSON body. Same as GET but with native boolean/number types."
}
},
{
"name": "Take Screenshot (WebP)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/screenshot?url=https://example.com&format=webp&quality=85&width=1920&height=1080",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot"],
"query": [
{
"key": "url",
"value": "https://example.com"
},
{
"key": "format",
"value": "webp"
},
{
"key": "quality",
"value": "85",
"description": "Image quality 1-100. Default: 90."
},
{
"key": "width",
"value": "1920"
},
{
"key": "height",
"value": "1080"
}
]
},
"description": "Capture a WebP screenshot with custom quality. WebP produces 25-50% smaller files than PNG."
}
},
{
"name": "Take Screenshot (PDF)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/screenshot?url=https://example.com&format=pdf",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot"],
"query": [
{
"key": "url",
"value": "https://example.com"
},
{
"key": "format",
"value": "pdf"
}
]
},
"description": "Generate a PDF document of a web page."
}
},
{
"name": "Full-Page Screenshot",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/screenshot?url=https://example.com&format=png&full_page=true",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot"],
"query": [
{
"key": "url",
"value": "https://example.com"
},
{
"key": "format",
"value": "png"
},
{
"key": "full_page",
"value": "true",
"description": "Capture the entire scrollable page. Default: false."
}
]
},
"description": "Capture the entire scrollable page, not just the visible viewport."
}
},
{
"name": "Dark Mode Screenshot",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/screenshot?url=https://example.com&format=png&dark_mode=true",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot"],
"query": [
{
"key": "url",
"value": "https://example.com"
},
{
"key": "format",
"value": "png"
},
{
"key": "dark_mode",
"value": "true",
"description": "Emulate prefers-color-scheme: dark. Default: false."
}
]
},
"description": "Capture a page in dark mode (for sites that support prefers-color-scheme: dark)."
}
},
{
"name": "Mobile Screenshot (iPhone 15 Pro)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/screenshot?url=https://example.com&format=png&device=iphone_15_pro",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot"],
"query": [
{
"key": "url",
"value": "https://example.com"
},
{
"key": "format",
"value": "png"
},
{
"key": "device",
"value": "iphone_15_pro",
"description": "Device preset: iphone_14, iphone_15_pro, pixel_7, ipad_pro, macbook_pro."
}
]
},
"description": "Capture a page as it appears on an iPhone 15 Pro (393x852, 3x DPR, mobile user agent)."
}
},
{
"name": "Screenshot with All Options",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/screenshot?url=https://example.com&format=webp&width=1920&height=1080&quality=90&full_page=false&dark_mode=false&block_ads=true&block_cookie_banners=true&delay=0&cache=true&cache_ttl=86400&response_type=binary",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot"],
"query": [
{
"key": "url",
"value": "https://example.com",
"description": "Required. URL to capture."
},
{
"key": "format",
"value": "webp",
"description": "png, jpeg, webp, or pdf. Default: png."
},
{
"key": "width",
"value": "1920",
"description": "Viewport width 320-3840. Default: 1280."
},
{
"key": "height",
"value": "1080",
"description": "Viewport height 200-10000. Default: 800."
},
{
"key": "quality",
"value": "90",
"description": "Image quality 1-100. Default: 90."
},
{
"key": "full_page",
"value": "false",
"description": "Capture full scrollable page. Default: false."
},
{
"key": "dark_mode",
"value": "false",
"description": "Dark mode emulation. Default: false."
},
{
"key": "block_ads",
"value": "true",
"description": "Block ads and trackers. Default: true."
},
{
"key": "block_cookie_banners",
"value": "true",
"description": "Remove cookie consent banners. Default: true."
},
{
"key": "delay",
"value": "0",
"description": "Wait ms after page load before capture (0-10000). Default: 0."
},
{
"key": "cache",
"value": "true",
"description": "Enable R2 caching. Default: true."
},
{
"key": "cache_ttl",
"value": "86400",
"description": "Cache TTL in seconds (clamped to plan max). Default: 86400."
},
{
"key": "response_type",
"value": "binary",
"description": "Response format: binary (raw image) or json (base64 data URI with metadata). Default: binary."
}
]
},
"description": "Screenshot with every available parameter. Modify as needed."
}
},
{
"name": "Screenshot Info (Cache Check)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/screenshot/info?url=https://example.com&format=png&width=1280&height=800",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot", "info"],
"query": [
{
"key": "url",
"value": "https://example.com"
},
{
"key": "format",
"value": "png"
},
{
"key": "width",
"value": "1280"
},
{
"key": "height",
"value": "800"
}
]
},
"description": "Check if a screenshot is cached and validate parameters without capturing. Does not count against quota."
}
}
],
"description": "Capture website screenshots in PNG, JPEG, WebP, or PDF format."
},
{
"name": "Signed URLs",
"item": [
{
"name": "Generate Signed URL",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"url\": \"https://example.com\",\n \"expires_in\": 86400\n}"
},
"url": {
"raw": "{{base_url}}/v1/screenshot/sign",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot", "sign"]
},
"description": "Generate a pre-signed URL that can render a screenshot without an API key. Signing is free and does not count against quota. The signed URL consumes one credit when rendered."
}
},
{
"name": "Generate Signed URL (Custom)",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"url\": \"https://example.com\",\n \"expires_in\": 604800,\n \"format\": \"jpeg\",\n \"width\": 1920,\n \"height\": 1080,\n \"dark_mode\": true,\n \"block_ads\": true\n}"
},
"url": {
"raw": "{{base_url}}/v1/screenshot/sign",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot", "sign"]
},
"description": "Generate a signed URL with custom screenshot settings and 7-day expiry."
}
},
{
"name": "Render Signed URL",
"request": {
"auth": { "type": "noauth" },
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/screenshot/render?url=https%3A%2F%2Fexample.com&expires=PASTE_EXPIRES&key_prefix=PASTE_PREFIX&sig=PASTE_SIG",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot", "render"],
"query": [
{ "key": "url", "value": "https%3A%2F%2Fexample.com" },
{ "key": "expires", "value": "PASTE_EXPIRES" },
{ "key": "key_prefix", "value": "PASTE_PREFIX" },
{ "key": "sig", "value": "PASTE_SIG" }
]
},
"description": "Render a screenshot using a signed URL. No API key required. Paste the values from the sign response."
}
}
],
"description": "Generate and use pre-signed URLs for sharing screenshots without exposing your API key."
},
{
"name": "Content Extraction",
"item": [
{
"name": "Extract Markdown",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/extract?url=https://example.com&type=markdown",
"host": ["{{base_url}}"],
"path": ["v1", "extract"],
"query": [
{ "key": "url", "value": "https://example.com" },
{ "key": "type", "value": "markdown" }
]
},
"description": "Extract readable content as Markdown from any web page."
}
},
{
"name": "Extract Article",
"request": {
"method": "POST",
"header": [
{ "key": "Content-Type", "value": "application/json" }
],
"body": {
"mode": "raw",
"raw": "{\n \"url\": \"https://example.com\",\n \"type\": \"article\"\n}"
},
"url": {
"raw": "{{base_url}}/v1/extract",
"host": ["{{base_url}}"],
"path": ["v1", "extract"]
},
"description": "Extract structured article with title, author, excerpt, and content."
}
},
{
"name": "Extract Metadata",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/extract?url=https://example.com&type=metadata",
"host": ["{{base_url}}"],
"path": ["v1", "extract"],
"query": [
{ "key": "url", "value": "https://example.com" },
{ "key": "type", "value": "metadata" }
]
},
"description": "Extract page metadata including title, description, and OG/Twitter tags."
}
},
{
"name": "Extract Links",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/extract?url=https://example.com&type=links",
"host": ["{{base_url}}"],
"path": ["v1", "extract"],
"query": [
{ "key": "url", "value": "https://example.com" },
{ "key": "type", "value": "links" }
]
},
"description": "Extract all links from a web page with their anchor text."
}
},
{
"name": "Extract with Selector",
"request": {
"method": "POST",
"header": [
{ "key": "Content-Type", "value": "application/json" }
],
"body": {
"mode": "raw",
"raw": "{\n \"url\": \"https://example.com\",\n \"type\": \"text\",\n \"selector\": \"#main-content\"\n}"
},
"url": {
"raw": "{{base_url}}/v1/extract",
"host": ["{{base_url}}"],
"path": ["v1", "extract"]
},
"description": "Extract text from a specific page element using a CSS selector."
}
}
],
"description": "Extract structured content from web pages. Supports markdown, text, html, article, links, and metadata extraction."
},
{
"name": "Usage",
"item": [
{
"name": "Get Current Usage",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/usage",
"host": ["{{base_url}}"],
"path": ["v1", "usage"]
},
"description": "Get current month's usage statistics including screenshots used, limit, and remaining."
}
},
{
"name": "Get Daily Usage",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/usage/daily?days=30",
"host": ["{{base_url}}"],
"path": ["v1", "usage", "daily"],
"query": [
{
"key": "days",
"value": "30",
"description": "Number of days to look back (1-90). Default: 30."
}
]
},
"description": "Get daily usage breakdown for the past N days. Useful for building usage charts."
}
}
],
"description": "Check your API usage and quota."
},
{
"name": "Batch Screenshots",
"item": [
{
"name": "Create Batch Job",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"urls\": [\n \"https://example.com\",\n \"https://github.com\",\n \"https://google.com\"\n ],\n \"format\": \"png\",\n \"width\": 1280,\n \"height\": 800\n}"
},
"url": {
"raw": "{{base_url}}/v1/screenshot/batch",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot", "batch"]
},
"description": "Create a batch screenshot job for up to 50 URLs. Returns a job ID immediately. Poll the status endpoint to track progress and get download URLs."
}
},
{
"name": "Get Batch Status",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/screenshot/batch/{{batch_job_id}}",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot", "batch", "{{batch_job_id}}"]
},
"description": "Poll the status of a batch screenshot job. Returns progress, completed download URLs, and any errors."
}
},
{
"name": "Batch with Options",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"urls\": [\n \"https://example.com\",\n \"https://github.com\"\n ],\n \"format\": \"jpeg\",\n \"width\": 1920,\n \"height\": 1080,\n \"full_page\": true,\n \"dark_mode\": true,\n \"quality\": 80\n}"
},
"url": {
"raw": "{{base_url}}/v1/screenshot/batch",
"host": ["{{base_url}}"],
"path": ["v1", "screenshot", "batch"]
},
"description": "Create a batch job with custom screenshot options applied to all URLs."
}
}
],
"description": "Batch screenshot processing. Submit multiple URLs and poll for results."
},
{
"name": "Webhooks",
"item": [
{
"name": "Create Webhook",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"url\": \"https://your-server.com/webhook\",\n \"events\": [\"screenshot.completed\", \"quota.warning\"]\n}"
},
"url": {
"raw": "{{base_url}}/v1/webhooks",
"host": ["{{base_url}}"],
"path": ["v1", "webhooks"]
},
"description": "Register a webhook URL to receive event notifications. Max 5 per account. Save the returned secret for signature verification."
}
},
{
"name": "List Webhooks",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/v1/webhooks",
"host": ["{{base_url}}"],
"path": ["v1", "webhooks"]
},
"description": "List all registered webhooks for your account."
}
},
{
"name": "Test Webhook",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{base_url}}/v1/webhooks/{{webhook_id}}/test",
"host": ["{{base_url}}"],
"path": ["v1", "webhooks", "{{webhook_id}}", "test"]
},
"description": "Send a test payload to a webhook to verify it's working."
}
},
{
"name": "Delete Webhook",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{base_url}}/v1/webhooks/{{webhook_id}}",
"host": ["{{base_url}}"],
"path": ["v1", "webhooks", "{{webhook_id}}"]
},
"description": "Remove a webhook. Future events will no longer be delivered."
}
}
],
"description": "Webhook management for event notifications (screenshot.completed, quota.warning, quota.exceeded)."
},
{
"name": "Health",
"item": [
{
"name": "Health Check",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/health",
"host": ["{{base_url}}"],
"path": ["health"]
},
"description": "Check API health status including Chromium, Redis, and PostgreSQL connectivity. No authentication required."
}
}
],
"description": "API health and status checks."
}
]
}