Logo
Pricing

Get Cached Image

GET
/api/v1/images/:key
Requires Authentication

Learn how to retrieve cached images using our API endpoint.

Request

key
REQUIRED

The unique key of the cached image, returned from the generate image endpoint.

Response

200 OK
Successful Response

Response Headers:

Content-Type
string

image/png or image/jpeg depending on the image format

Content-Length
number

Size of the image in bytes

X-Generation-Time
number

Time taken to process the request in milliseconds

Cache-Control
string

public, max-age=31536000 (1 year)

400 Bad Request
Invalid Parameters
401 Unauthorized
Invalid or Missing API Key
404 Not Found
Image Not Found or Expired
429 Too Many Requests
Rate Limit Exceeded

Related Resources

Generate Image API ReferenceError Handling Guide

LANGUAGE

AUTHENTICATION
API KEY

Header
X-API-Key: your_api_key_here

REQUEST

RESPONSE

PreviousGet Template Details
NextError Handling