Get Image

In DAM, images are identified by their filename (reference), which is unique per tenant.
Use this endpoint to retrieve a specific image when you already know its filename.

Authentication

Requires a valid API key in the X-API-KEY header.

Example

GET /images(product-main-front.jpg)
X-API-KEY: your-api-key-here

Response (200 OK)

{
  "id": 42,
  "reference": "product-main-front.jpg",
  "numLinks": 3,
  "status": "Ok",
  "modifiedOn": "2024-04-05T08:44:33",
  "fileType": "png",
  "createdOn": "2024-04-05T08:44:33",
  "tags": ["animales", "mascotas"],
  "originalUrl": "https://cdn.example.com/product-main-front.jpg",
  "thumbnailUrl": "https://cdn.example.com/perrito-simpatico_TH.png",
  "thumbnailMediumUrl": "https://cdn.example.com/perrito-simpatico_THM.png",
  "thumbnailPreviewUrl": "https://cdn.example.com/perrito-simpatico_THP.png",
  "width": 800,
  "height": 600,
  "sizeInBytes": 102400
}

Error Responses

• 400 Bad Request: Invalid API key
• 401 Unauthorized: Missing API key
• 404 Not Found: No image with the given reference exists for this tenant

Endpoint: GET /images({reference})
Version: 2.0.0

Header parameters:

• X-API-KEY (string)
  Tenant's API key (required)

Path parameters:

• reference (string, required)
  Image filename, unique per tenant (e.g. product-main-front.jpg)

Response 200 fields (application/json):

• id (integer)
• reference (string,null)
• numLinks (integer)
• status (string,null)
• modifiedOn (string)
• fileType (string,null)
• createdOn (string,null)
• tags (array,null)
• originalUrl (string,null)
• thumbnailUrl (string,null)
• thumbnailMediumUrl (string,null)
• thumbnailPreviewUrl (string,null)
• width (integer)
• height (integer)
• sizeInBytes (integer)

Response 400 fields (application/json):

• type (string,null)
• title (string,null)
• status (integer,null)
• detail (string,null)
• instance (string,null)