GET
/
api
/
images
/
{id}
cURL
curl --request GET \
  --url https://api.gnomy.io/api/images/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "template_id": "<string>",
  "image_url": "<string>"
}
Retrieves a specific generated image by its ID.

​
Authentication

This endpoint requires an API key for authentication. Include your API key in the request headers using the x-api-key header.

​
Path Parameters

ParameterTypeRequiredDescription
idstringYesThe ID of the image to retrieve

​
Response

​
Success Response (200 OK)

{
  "id": "string",
  "created_at": "string (ISO date)",
  "template_id": "string",
  "image_url": "string"
}

​
Error Response (400 Bad Request)

{
  "error": "Image ID is required"
}

​
Error Response (401 Unauthorized)

{
  "error": "Unauthorized"
}

​
Error Response (404 Not Found)

{
  "error": "Image not found"
}

​
Error Response (500 Internal Server Error)

{
  "error": "Error message"
}

​
Example

curl -X GET "https://api.example.com/api/images/image123" \
  -H "x-api-key: YOUR_API_KEY"

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

The ID of the image to retrieve

Response

200
application/json

Successfully retrieved image

The response is of type object.