Preview an asset
Shows an image asset as a model can look at it: upright, at most 1568 pixels on its longest side, as base64 JPEG.
Guide: Fonts and images
AuthorizationBearer <token>
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
projectId*string
The project's id, proj_.... A secret key works only in the project it belongs to.
assetId*string
The asset's id, asset_... or pw_asset_....
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/assets/asset_n5q0w2e7h7d2k9m4x1c6v8b3/preview" \ -H "Authorization: Bearer vh_sk_..."{ "contentType": "image/jpeg", "imageBase64": "/9j/4AAQSkZJRgABAQAAAQABAAD...", "width": 1170, "height": 780, "sourceWidth": 1170, "sourceHeight": 780}{ "error": { "type": "invalid_request", "code": "image_unreadable", "message": "It isn't a JPEG, PNG, WebP or GIF image of up to 16 megapixels that Voidhash can read." }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "asset_not_found", "message": "There is no asset asset_n5q0w2e7h7d2k9m4x1c6v8b3.", "param": "assetId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | image_unreadable | For an asset that is not a JPEG, PNG, WebP or GIF image. |
| 400 | invalid_request | image_too_large | For one over 30 MB. |
| 404 | not_found | asset_not_found | — |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Assets
- List assets
GET - Retrieve an asset
GET
Something wrong or missing on this page? Tell us by email or on Discord.