Get Started

Overview

REST API

Rate limit Troubleshooting Authentication Screenshots Snaps Templates

API Reference

Overview

Other resources

Guides

Screenshots

Please go to the Screenshot object reference to learn more about how this object works.

# Overview

One of the most useful features from SnapsBrew is being able to get screenshots of your own site pages. Sometimes you don't want to generate a custom image but just show a preview of the page your visitors will see. Doing this with SnapsBrew is as easy as it gets.

# Create a Screenshot

This endpoint will allow you to make a POST request to create images from website screenshots. Basically, the only required field is url, but you can customize the browser size. Take a look below.

POST https://snapsbrew.com/api/v1/screenshots

Request

{
  "url": "https://legendsverse.com",
  "width": 1330,
  "height": 780
}
url Required
The website page you want to take a screenshot to.
width Default: 1330
The width of the browser you are going to take a screenshot to.
height Default: 780
The height of the browser you are going to take a screenshot to.

Response

{
  "uuid": "73824855-47b0-421d-be7d-e238ebfbfe29",
  "url": "https://legendsverse.com",
  "image_url": "https://snapsbrew.com/storage/43/conversions/media-librarywE0C8F-image.jpg",
  "width": 1330,
  "height": 780,
  "created_at": "1985-10-15:18:38.000000Z"
}

# List Screenshots

This endpoint will allow you to make a GET request to get a list of the screenshots that have been created. This endpoint doesn't have any required fields but you certainly need to add a few to travel trough the paginated list.

GET https://snapsbrew.com/api/v1/screenshots

Request

{
  "cursor": "1041afe7-b9c3-42ef-8530-6910bb486e76"
}
cursor
Cursor position of the paginated response.
pagination Default: 15
The items quantity returned in each response page.

Response

{
  "items": [
    {
      "uuid": "859419e5-765d-4711-b76b-95f4b05e73bf",
      "url": "https://legendsverse.com",
      "image_url": "https://images.socialcards.xyz/storage/859419e5/legendsverse-com.png"
      "width": 1330,
      "height": 780,
      "created_at": "1985-10-15T00:00:00.619Z"
    },
    {
      "uuid": "775d1f4a-370e-42b4-ba90-3ed20181f7b8",
      "url": "https://miispeek.com",
      "image_url": "https://images.socialcards.xyz/storage/775d1f4a/miispeek-com.png"
      "width": 1330,
      "height": 780,
      "created_at": "1955-10-15T00:00:00.619Z"
    },
    {
      "uuid": "11f58c0f-8aa8-4f43-a1a2-282047b08558",
      "url": "https://remotedevs.lat",
      "image_url": "https://images.socialcards.xyz/storage/775d1f4a/remotedevs-lat.png"
      "width": 1330,
      "height": 780,
      "created_at": "1895-10-15T00:00:00.619Z"
    }
  ],
  "metadata": {
    "items_per_page": 15,
    "next_page_cursor": "d78ae80b-34d5-4a1e-8845-48bbff14697b",
    "previous_page_cursor": null
  }
}

# View a Screenshot

This endpoint will allow you to make a GET request to get a single screenshot.

GET https://snapsbrew.com/api/v1/screenshots/{screenshotUuid}

Response

{
  "uuid": "73824855-47b0-421d-be7d-e238ebfbfe29",
  "url": "https://legendsverse.com",
  "image_url": "https://snapsbrew.com/storage/43/conversions/media-librarywE0C8F-image.jpg",
  "width": 1330,
  "height": 780,
  "created_at": "1985-10-15:18:38.000000Z"
}

Contents