API Playground

Enable automatic image processing for product enrichment

Authentication Required

You need to Login to test the API playground

Image Standardization Settings

Enable automatic image processing for product enrichment

When enabled, all product images will be automatically standardized during the enrichment process. This includes format conversion, compression, and optimization.

Note: Enabling image standardization will consume 1 additional credit per product during creation.

Get Current Setting

GET
Endpoint URL
GET https://api.commerceclarity.com/api/v1/profile/settings/image-standardization

Response Example

Success Response 
{
  "success": true,
  "data": {
    "image_standardization": true
  }
}

Update Setting

PUT
Endpoint URL
PUT https://api.commerceclarity.com/api/v1/profile/settings/image-standardization

Request Parameters

Parameter Type Required Description
enabled boolean Required Set to true to enable automatic image standardization, false to disable

Request Examples

curl -X PUT "https://api.commerceclarity.com/api/v1/profile/settings/image-standardization" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true
  }'
curl -X PUT "https://api.commerceclarity.com/api/v1/profile/settings/image-standardization" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false
  }'
$client = new \GuzzleHttp\Client();
$apiToken = 'your_api_token_here';

// Enable image standardization
$response = $client->put('https://api.commerceclarity.com/api/v1/profile/settings/image-standardization', [
    'headers' => [
        'Authorization' => 'Bearer ' . $apiToken,
        'Content-Type' => 'application/json',
    ],
    'json' => [
        'enabled' => true
    ]
]);

$data = json_decode($response->getBody(), true);
const apiToken = 'your_api_token_here';

// Enable image standardization
const response = await fetch('https://api.commerceclarity.com/api/v1/profile/settings/image-standardization', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${apiToken}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    enabled: true
  })
});

const data = await response.json();

Response Examples

Success Response
{
  "success": true,
  "data": {
    "image_standardization": true
  }
}
Error Response
{
  "success": false,
  "errors": [
    "The enabled field is required."
  ]
}