Visual Content Coach: AI-generated media ideas API
This section outlines the purpose of the Visual Content Coach: AI-generated media ideas API and provides implementation guidance, including sample request and response.
Use the Visual Content Coach: AI-generated media ideas API to provide media guidelines in the submission form. These guidelines help consumers capture high-quality photos and videos with their reviews. High-quality, compliant media improves review quality, influences purchase decisions, and drives conversions.
Note:
AI-generated media ideas are available in English (en), Spanish (es), German (de), and French (fr) locales.
| Environment | URL |
|---|---|
| Production | https://api.bazaarvoice.com |
| Staging | https://stg.api.bazaarvoice.com |
Endpoint
[GET] /data/content-coach/v1/review-visual-guidelines
HTTP Method
https\://[stg].api.bazaarvoice.com/data/content-coach/v1/review-visual-guidelines?type=text&productId=<productId>&locale=en_US'
--header 'bv-passkey: <passkey>'
Parameters
Note: Parameters marked with an asterisk (*) are mandatory.
| Parameter | Placement | Data type | Description |
|---|---|---|---|
bv-passkey * | Header | String | A Conversations API key for authentication. This should be sent through the HTTP header. |
productId * | Query | String | The unique identifier of the product (e.g., P-7777-MSD). |
type * | Query | String | Indicates the response format of the media guidelines, which is text. |
locale Format: languageCode_countryCode Any other format will return a bad request response | Query | String | Indicates the language of the media guidelines. The supported locales are English (en__*), German (de_*), French (fr_*), and Spanish (es_*). Example: en_US |
Example
Request
curl --location 'https://[stg].api.bazaarvoice.com/data/content-coach/v1/review-visual-guidelines?type=text&productId=<productId>&locale=en_US'
--header 'bv-passkey: <passkey>'
Response
{
"guidelines": [
{
"heading": "Daily Essential",
"idea": "Capture the product on your nightstand with morning light, showing it as part of your routine."
},
{
"heading": "In Action",
"idea": "Film yourself using the product naturally, highlighting how it fits seamlessly into your day."
},
{
"heading": "Desk Companion",
"idea": "Place it next to your laptop and coffee, showing productivity and everyday workspace integration."
},
{
"heading": "Travel Ready",
"idea": "Pack it in your bag or show it travel-ready, demonstrating portability and on-the-go convenience."
},
{
"heading": "Perfect Moment",
"idea": "Capture the product during a relaxed evening at home, with warm lighting and comfortable setting."
}
]
}
Errors
| Error code | Description |
|---|---|
| 400 - Missing or Invalid passkey | Invalid or missing passkey parameter. |
| 400 - Empty query parameter | The request is missing a query parameter: clientName |
| 401 - Unauthorized | Authentication failed because of invalid or missing passkey. |
| 404 - Guidelines not found for valid product | No dynamic guidelines are found for the requested productId and passkey. |
| 404 - Product ID does not exist or is inactive | The product-ID is either inactive or missing required attributes: productName or categoryName. Please check your product configuration. |
| 406 - Language not supported | The requested language is not supported. |
| 406 - Guidelines type not supported | Unsupported guideline type. Please use text. |
Updated 3 days ago