Manual
CLI
API
Log in Get started free

Download a screenshot of a key

Returns the image of a screenshot.

Returns the image of a screenshot. The list of screenshots of a key is part of Get a key.

HTTP
GET /keys/{keyId}/assets/{assetId}

Access: Session token only. API keys get 403 with insufficient_scope.

Role: Any role in the project.

Path parameters #

ParameterDescription
keyIdThe id of the key.
assetIdThe id of the screenshot.

Response 200 #

The image itself, not JSON. Content-Type is the mimeType of the screenshot, Content-Disposition is inline with its file name, and the response carries X-Content-Type-Options: nosniff. The request needs the Authorization header, so an <img> tag cannot load it directly: fetch it and show the result.

Errors #

StatuserrorWhen
401unauthenticatedThe token is missing or not valid.
404not_foundThe key does not exist, you have no access to its project, keyId or assetId is not a UUID, or the key has no such screenshot.
429rate_limitedToo many requests, see Rate limiting.

See Errors for the error format.