API Documentation

GET /screenshots/:uuid

Fetch screenshots data for a given uuid.

Screenshot URLs expire 7 days after the request is made. If you need to access these screenshot images outside this 7 day window you can download and store or host the image asset elsewhere.

Example Request:

curl "https://api.preflight.qa/screenshots/1b153496-f702-4f89-85b4-cd1a9516cbbe" \
  -H "Authorization: Bearer <api_token>" \
  -H "Content-Type: application/json"

Example Response

Returns a collection of all the requested screenshots, with the app, mode, status, and url if complete:

{
  "data":{
    "screenshots": [
      {
        "app": "outlook_mac",
        "mode": "light",
        "status": "complete",
        "url": "http://preflight.qa/screenshot.png"
      },
      {
        "app": "outlook_mac",
        "mode": "dark",
        "status": "pending",
        "url": null
      }
    ]
  },
  "meta": {
    "credits": {
      "remaining": 331,
      "period_ends_at": "2026-05-03T16:57:56Z"
    },
    "rate_limits": {
      "general": {
        "limit": 12,
        "remaining": 11,
        "reset_at": "2026-04-15T09:05:00Z"
      }
    },
    "uuid": "1b153496-f702-4f89-85b4-cd1a9516cbbe"
  }
}