- Getting started
- CREDIT ENDPOINTS
- GENERATE ENDPOINTS
- GETText generation rules and limits
- GETAvailable text generation tones
- GETText generation styles
- GETTarget audiences for text generation
- GETAvailable text types for generation
- GETText generation history
- GETStatus of generated texts
- GETGenerated text for multiple records
- GETActive generation requests
- GETDetails of a specific generation request
- POSTText generation
- POSTCancel a bulk generation request
- POSTUpdate generated text fields
- IMAGE ENDPOINTS
- KEYWORDS ENDPOINTS
- GETKeyword optimization data
- POSTOptimize keywords for text
- DELETEKeyword optimization
- PUTKeyword optimization
- GETKeyword optimization list
- PUTKeyword optimization data
- DELETERanking keywords
- PUTKeyword optimization pipelines
- GETKeyword state
- POSTKeyword pipeline
- DELETEKeyword pipeline
- POSTRestore keyword pipeline
- POSTAdd triggers to keyword pipeline
- POSTAdd triggers to a specific keyword pipeline
- POSTLock a specific keyword pipeline
- POSTUnlock a specific keyword pipeline
- GETPipeline snapshots
- PUTUpdate or create a snapshot
- POSTAdd manual keywords
- GETManual keywords
- REVIEW ENDPOINTS
- SUGGESTION ENDPOINTS
Get images and their metadata
get
/text/Image/List
This endpoint retrieves a list of images with their corresponding metadata. You can filter by storefront, language, or specific image IDs and optionally include the alt text update history.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
| Parameter Name | Type | Description |
|---|---|---|
| storeId | string, optional | The storefront location identifier for the image. This helps differentiate images between different stores. Default is default. |
| language | string, optional | A language code to filter the images by language. It returns the alt text in the specified language. |
| images | array[string], optional | A list of image IDs. This allows you to fetch specific images if you know their IDs. |
| includeUpdateHistory | boolean, optional | If set to true, it includes the alt text update history in the response. Default is false. |
Example API Request
Response
200
400
404
500
//Returns the metadata of the requested images, including their URLs, alt texts, and modification history (if requested).
//If any of the parameters are invalid.
//If the specified images are not found.
//The server encountered an error when processing the request.