API Reference

Overview

Screenshot Details

The Snapshot Screenshot Details API lets you retrieve the metadata and final result of a previously captured website screenshot using its screenshot ID. The response includes the captured URL, image URL, viewport dimensions, full-page setting, image format, quality, capture timing, page loading configuration, and screenshot status. When enabled during capture, the response can also include URLs for extracted HTML and text. Use this endpoint when your application needs to retrieve or inspect the result of a previously created screenshot, including screenshots generated through scheduled capture workflows.

Endpoint

GEThttps://snapshot-api.mindiqglobal.com/api/v1/screenshots/{screenshotId}

Path Parameters

NameRequiredTypeDescription
screenshotIdYesintegerScreenshot ID.

Success Response

{
  "id": 101,
  "url": "https://example.com",
  "imageUrl": "https://cdn.snapshot.ai/images/detail.png",
  "width": 1920,
  "height": 1080,
  "fullPage": true,
  "format": "png",
  "responseType": "json",
  "quality": 100,
  "delay": 0,
  "waitUntil": "page_loaded",
  "waitUntilTimeout": 15,
  "waitFor": "#app",
  "crop": null,
  "element": null,
  "thumbnailWidth": null,
  "userAgent": null,
  "acceptLanguage": null,
  "extractedHtmlUrl": "https://cdn.snapshot.ai/images/detail.html",
  "extractedTextUrl": "https://cdn.snapshot.ai/images/detail.txt",
  "status": "SUCCESS",
  "processingTimeMs": 321,
  "createdAt": "2026-08-03T10:00:00Z",
  "completedAt": "2026-08-03T10:00:01Z",
  "description": null,
  "scheduleExecutionId": null,
  "scheduleItemId": null
}

Response Body Parameters

NameTypeDescription
idintegerScreenshot ID.
urlstringCaptured URL.
imageUrlstringScreenshot image URL.
widthinteger | nullCapture viewport width.
heightinteger | nullCapture viewport height.
fullPagebooleanFull page flag. Possible values: true, false.
formatenumOutput image format. Possible values: png, jpeg.
responseTypeenumjson or image.
qualityinteger | nullJPEG quality (0-100).
delaynumber | nullConfigured delay in seconds.
waitUntilenum | nulldom_loaded, page_loaded, network_idle.
waitUntilTimeoutnumber | nullwait_until timeout in seconds.
waitForstring | nullConfigured CSS selector wait target.
cropstring | nullCrop rectangle as left,top,width,height.
elementstring | nullElement selector target.
thumbnailWidthinteger | nullThumbnail width if requested.
userAgentstring | nullCustom user agent used for capture.
acceptLanguagestring | nullCustom accept-language used for capture.
extractedHtmlUrlstring | nullExtracted HTML URL when enabled.
extractedTextUrlstring | nullExtracted text URL when enabled.
statusstringScreenshot status (examples: SUCCESS, FAILED).
processingTimeMsinteger | nullProcessing time in milliseconds.
createdAtdatetimeScreenshot creation datetime in ISO-8601 format.
completedAtdatetime | nullScreenshot completion datetime in ISO-8601 format.
descriptionstring | nullOptional details (for example, failure details).
scheduleExecutionIdinteger | nullParent schedule execution ID for scheduled captures.
scheduleItemIdinteger | nullParent schedule item ID for scheduled captures.