Brand Brain Commerce API (1.12.0)

Download OpenAPI specification:

Brand Brain: info@satalia.com URL: https://www.satalia.com License: Proprietary

Introduction

The Brand Brain Commerce API enables seamless management of jobs related to Content Generation, Content Analysis, and Content Adaptation. Through this API, users can initiate jobs for these services and track their progress in real-time.

Overview

This API serves as a central gateway for managing content services. Users can:

Submit jobs for Content Generation, Content Analysis and Content Adaptation.
Monitor job progress using the provided job_id.
Retrieve results asynchronously upon job completion.

Validation Process

When a job request is submitted, the API performs an initial validation of the input payload to ensure it adheres to the supported formats and configuration standards. Note: This validation does not verify the correctness of submitted products or their IDs.

Background Operations

Once validated, the API initiates a background process that:

Retrieves necessary product data.
Executes the requested content operation (e.g generation, analysis or adaptation).
Delivers the results to the designated output location asynchronously.

Job Tracking

Upon successful submission, the API returns a job_id. Users can leverage this ID to:

Check the status of their job.
Access the generated output when the job is completed.

The Brand Brain Commerce API streamlines the handling of complex content workflows, enabling efficient and scalable operations for your business needs.

Content Generation

Generate content for the given product data.

Submit a job for Content Generation.
Query the status of the job.
Retrieve the generated result.
Submit feedback for the generated content.
Retrieve the Content Configuration used for the job.

Submit Content Generation job

Entrypoint to submit a job for Content Generation.

Submits a job for Content Generation using the supplied parameters.

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json
required

The parameters for the Content Generation job.

Ensure that either products or product_ids is provided, but not both. Requests containing both will be rejected.

external_tracking_id	string non-empty An optional external job ID to be used for internal tracking purposes.
product_ids	Array of strings non-empty [ items non-empty ] The IDs of the products for which content will be generated. The product data must have already been submitted and stored within the system. Note: only `product_ids` or `products` can be given, not both.
	Array of objects (Product) non-empty The list of products for which content will be generated. Note: only `products` or `product_ids` can be given, not both.
skip_grouping	boolean Default: false Whether to skip grouping the products into variations. Note: if a `master_pdp` is given in the `content_generation_params`, then this flag is ignored.
required	object Parameters for the Content Generation job.
generation_model_name	string (Content Generation LLM Model) non-empty Default: "gpt-4.1" Value: "gpt-4.1" The name of the LLM model to be used.
callback_url	string <uri> (Callback URL) non-empty The URL is called whenever there are changes in the job status, providing real-time updates on progress or completion.

Responses

Callbacks

Request samples

Payload

Content type

application/json

Example

With Products and Config

Includes a minimum request required to submit with products and custom configuration (content_generation_params.content_config).

Submitting product_ids in place of products is also possible, refer to the schema or other examples for details.

{"external_tracking_id": "8a6953e1-cc2b-4be6-8d8b-f0a87daf7334",
"products": [{"product_id": "1234567890001",
"product_name": "QuantumTech Gadget",
"product_description": "A high-tech gadget designed for modern needs.",
"brand": "QuantumTech",
"market": "uk",
"language": "en",
"variant_group_id": "G123456",
"keywords": {"generic": ["tech",
"gadget"
],
"title": ["Quantum",
"Tech"
],
"avoid": ["obsolete"
],
"desc_must_claims": ["A simple claim that is verbatim and must be included within the description",
"'Claim': A verbatim claim that must be included within the description, 'Disclaimer': A verbatim disclaimer that corresponds to the 'Claim' and must be included at the end of the description"
],
"desc_optional_claims": ["A simple claim that is non-verbatim and it can optionally be included within the description"
],
"bullets_must_claims": ["A simple claim that is verbatim and must be included within the bullet points",
"'Claim': A verbatim claim that must be included within the bullet point, 'Disclaimer': A verbatim disclaimer that corresponds to the 'Claim' and must be included at the end of the bullet point"
],
"bullets_optional_claims": ["A simple claim that is non-verbatim and it can optionally be included within the bullet points"
]
},
"reviews": [{"review_id": "XYZ987654321",
"review_text": "An innovative product that exceeded my expectations!",
"cust": "techguru"
}
],
"attributes": [{"name": "long_product_name",
"value": "Some Gadget"
},
{"name": "brand",
"value": "QuantumTech"
},
{"name": "colour",
"value": "Black"
}
]
}
],
"content_generation_params": {"market": "uk",
"channel": "TechStore",
"language": "en",
"content_types": ["title",
"bullets",
"desc"
],
"content_config": {"word_map": {" - ": ", ",
"Not Applicable": ""
},
"tone": {"GENERIC": {"Our product is capable of many things": "Explore the endless potential of our versatile product, engineered to unlock a world of possibilities for you."
}
},
"client": {"prompt_attributes": ["Long Product Name",
"Brand",
"Colour"
],
"forbidden_words": ["shopper barrier",
"shopping barrier"
],
"content_type_family_map": {"title": "title",
"bullets": "bullets",
"desc": "string"
},
"field_map": {"short_description": "Sub Category",
"reviews": "Reviews",
"brand": "Brand",
"long_product_name": "Long Product Name"
},
"validation_entities": ["PRODUCT_NAME",
"SIZE"
],
"false_words_entity_map": {"COLOR": "Colour",
"SIZE": "Size"
},
"review_attributes": ["Reviews",
"Positive reviews"
],
"variant_data_fields": ["Colour",
"Effect"
],
"style_guide_content_types": ["bullets",
"desc"
],
"tone_content_types": ["bullets",
"desc"
],
"skip_content_types": ["howtouse"
]
},
"style_guide": {"tone_of_voice": "Informal but professional",
"writing_style": "Simple and concise",
"target_audience": "General audience",
"grammar": "Correct usage of grammar and punctuation",
"emotional_tone": "Neutral",
"punctuation": "Limited use of commas and full stops.",
"language": "Easy to understand language. Avoid using jargon and complex words.",
"pitch": "Positive and optimistic",
"choice_of_words": "Use simple words and phrases. Avoid using slang or offensive language.",
"use_of_emoticons": "Emoticons can be used in informal communications but not in professional communications.",
"pattern": "Use short paragraphs and bullet points for better readability.",
"industry": "General"
},
"content_types": {"title": {"task": "Write a Ecommerce sales title for the product. Try to include as many Search Keywords and Attributes as possible within the title.",
"character_limit": 100,
"guidelines": ["* Don't mention any competitor."
],
"guidelines_shortener": ["* Respect the order of appearance."
],
"restrictions": ["* Never use ALL CAPS in your product titles."
],
"additions": {"title": "{{attr.brand}}, {{title}}, {{attr.sub_brand}}"
},
"keyword_groups": {"should": ["IncludeThisTitleKeywordGroup"
],
"must": ["MustIncludeThisTitleKeywordGroup"
],
"omit": ["SomeBadTitleKeywordGroup"
]
}
},
"bullets": {"task": "I want 5 bullet points explaining the highlights of the product. Try to include as many Search Keywords and Attributes as possible within the bullet points.",
"character_limit": 250,
"guidelines": ["* Format the bullet points as concise sentence fragments without verbs."
],
"guidelines_shortener": ["Always finish a bullet point with a full stop."
],
"restrictions": ["* Conclude each bullet point with a full stop."
],
"additions": {"bullets_1": "How to: {{bullets_1}}"
},
"keyword_groups": {"should": ["IncludeThisBulletsKeywordGroup"
],
"must": ["MustIncludeThisBulletsKeywordGroup"
],
"omit": ["SomeBadBulletsKeywordGroup"
],
"verbatim_must_claims": ["bullets_must_claims"
],
"non_verbatim_optional_claims": ["bullets_optional_claims"
]
}
},
"desc": {"task": "Write a long description of the product. Use about 200 words.",
"character_limit": 1000,
"guidelines": ["* Don't use hashtags or '#'."
],
"guidelines_shortener": ["Always ensure grammar is correct."
],
"restrictions": ["* Write in complete sentences and use a full stop at the end."
],
"additions": {"desc": "{{desc}} \nThanks, from the team at {{attr.brand}}!"
},
"keyword_groups": {"should": ["IncludeThisDescKeywordGroup"
],
"must": ["MustIncludeThisDescKeywordGroup"
],
"omit": ["SomeBadDescKeywordGroup"
],
"verbatim_must_claims": ["desc_must_claims"
],
"non_verbatim_optional_claims": ["desc_optional_claims"
]
}
}
}
}
}
}

Response samples

201
400
409

Content type

application/json

{"job_id": "13d87fb8-a940-447c-9755-dbe6c631ef57"
}

Callback payload samples

Callback

POST: Job Updates

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"status": "completed"
}

Get Content Generation job status

Retrieve the status of a Content Generation job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

Example

Completed

{"status": "completed",
"message": "The job has completed successfully."
}

Get Content Generation job result

Retrieve the result of a Content Generation job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

Example

Successfully Generated Result

Content Generation was successful for one Product.

{"01234567": {"content": {"title": "This is a test title.",
"desc": "This is a description lorem ipsum dolor sit amet."
},
"product": {"product_id": "01234567",
"product_name": "Tester",
"product_description": "Some product description.",
"brand": "satalia_gen",
"market": "uk",
"language": "en",
"variant_group_id": "P9999999",
"keywords": {"title": ["tester",
"Satalia"
]
},
"reviews": [{"review_id": "3G7H2Qf4R5pE8Jw8",
"review_text": "It was a great product. Thanks!",
"cust": "satalia"
}
],
"attributes": [{"name": "ean",
"value": "01234567"
}
]
},
"warnings": [{"content_type": "title",
"code": "EXCEED_LENGTH",
"description": "title exceeds length by 21 characters"
},
{"content_type": "desc",
"code": "EXCEED_LENGTH",
"description": "desc exceeds length by 11 characters"
}
]
}
}

Get Content Generation job Content Configuration

Retrieve the used Content Configuration for a Content Generation job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string <uuid>

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

{"guidelines": ["This is a guideline."
],
"guidelines_shortener": ["This is a shortener guideline."
],
"restrictions": ["This is a restriction."
],
"word_map": {"Foo": "Bar"
},
"tone": {"SomeBrand": {"SomeToneKey": "SomeToneValue"
}
},
"keyword_groups": {"should": ["generic_keyword",
"product_category_keyword"
],
"omit": ["word_to_avoid"
]
},
"client": {"prompt_attributes": ["Long Product Name",
"Brand",
"Colour"
],
"forbidden_words": ["shopper barrier",
"shopping barrier"
],
"content_type_family_map": {"title": "title",
"bullets": "bullets",
"desc": "string",
"short_title": "title",
"long_title": "title",
"short_desc": "string"
},
"field_map": {"short_description": "Sub Category",
"reviews": "Reviews",
"brand": "Brand",
"long_product_name": "Long Product Name"
},
"validation_entities": ["PRODUCT_NAME",
"SIZE"
],
"false_words_entity_map": {"COLOR": "Colour",
"SIZE": "Size"
},
"review_attributes": ["Reviews",
"Positive reviews"
],
"variant_data_fields": ["Colour",
"Effect"
],
"tone_content_types": ["bullets",
"short_bullets",
"desc",
"short_desc"
],
"skip_content_types": ["title",
"howtouse"
]
},
"content_types": {"title": {"task": "Write a title for the product...",
"character_limit": 100,
"guidelines": ["This is a good guideline."
],
"guidelines_shortener": ["This is a shortener good guideline."
],
"restrictions": ["This is a good restriction."
],
"additions": {"title": "{{attr.brand}}, {{title}}, {{attr.sub_brand}}"
},
"keyword_groups": {"must": ["title_keyword"
]
}
},
"desc": {"task": "Write a description for the product...",
"character_limit": 1000,
"keyword_groups": {"should": ["description_keyword"
]
}
},
"bullets": {"task": "Write some bullets for the product...",
"character_limit": 250,
"additions": {"bullets_1": "How to: {{bullets_1}}",
"bullets_3": "Ingredients: {{bullets_3}}"
}
}
}
}

Submit Feedback for Content Generation job

Submit feedback for a Content Generation job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Request Body schema: application/json
required

The feedback for the Content Generation job.

product_id required	string The ID of the product for which content was generated.
required	object (PDP Content) The initial PDP content.
required	object (PDP Content) The corrected PDP content.
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"product_id": "1234567890123456",
"initial_pdp_content": {"title": "QuantumTech Quantum Speaker 2024",
"desc": "This is the initial description for the QuantumTech Quantum Speaker 2024. It's a top-tier audio device designed to deliver unmatched sound quality. Crafted with the latest sound engineering technologies, it offers an immersive listening experience. Its sleek design and intuitive controls make it a perfect addition to any modern home. Enjoy crystal-clear audio whether you're listening to music, watching movies, or gaming.",
"howtouse": "Connect to your device via Bluetooth or auxiliary cable. Adjust the volume to your preference. Enjoy high-quality sound.",
"bullets": ["Immersive sound quality",
"Sleek and modern design"
]
},
"corrected_pdp_content": {"title": "Corrected QuantumTech Quantum Speaker 2024",
"desc": "This is the corrected description for the QuantumTech Quantum Speaker 2024. It's a top-tier audio device designed to deliver unmatched sound quality. Crafted with the latest sound engineering technologies, it offers an immersive listening experience. Its sleek design and intuitive controls make it a perfect addition to any modern home. Enjoy crystal-clear audio whether you're listening to music, watching movies, or gaming.",
"howtouse": "Connect to your device via Bluetooth or auxiliary cable. Adjust the volume to your preference. Enjoy high-quality sound.",
"bullets": ["Immersive sound quality",
"Sleek and modern design"
]
},
"comment_history": [{"initial_content": "QuantumTech Quantum Speaker 2024",
"content_type": "title",
"feedback": "Incorrect naming convention",
"created_at": "2024-01-01T13:00:00Z",
"created_by": "joe.bloggs"
},
{"initial_content": "Connect to your device via Bluetooth or auxiliary cable. Adjust the volume to your preference. Enjoy high-quality sound.",
"content_type": "howtouse",
"feedback": "Needs additional instruction for pairing mode",
"created_at": "2024-01-01T14:00:00Z",
"created_by": "jane.doe"
},
{"initial_content": ["Immersive sound quality",
"Sleek and modern design"
],
"content_type": "bullets",
"feedback": "Add more details about sound features",
"created_at": "2024-01-01T14:00:00Z",
"created_by": "jane.doe"
},
{"initial_content": ["Immersive sound quality",
"Sleek and modern design with easy-to-use controls"
],
"content_type": "bullets",
"feedback": "Ensure consistency in bullet format",
"created_at": "2024-01-04T14:00:00Z",
"created_by": "joe.bloggs"
}
]
}

Response samples

400
404
409

Content type

application/json

Example

Bad Request Body

When the given request body does not meet the spec.

{"code": "bad_request",
"message": "Invalid request body"
}

Review Summariser

Generate a Review Summaries for a given list of reviews.

Submit a job for Review Summariser - Content Analysis.
Query the status of the job.
Retrieve the generated result.

Submit Review Summariser - Content Analysis job

Entrypoint to submit a job for Review Summariser - Content Analysis.

Submits a job for to summarise reviews.

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json
required

The parameters for the Review Summariser - Content Analysis job.

external_tracking_id	string non-empty An optional external job ID to be used for internal tracking purposes.
market required	string (Market) Enum: "ar" "be" "bg" "bo" "br" "cl" "cn" "co" "cr" "cz" "de" "dk" "do" "ec" "ee" "es" "fi" "fr" "gb" "gr" "gt" "hn" "hu" "id" "it" "jp" "kr" "lt" "lv" "mx" "ni" "nl" "no" "pa" "pe" "pl" "pr" "pt" "py" "ro" "ru" "se" "si" "sk" "sv" "tr" "ua" "uk" "us" "uy" "ve" The market code for which content is being analysed. Available '<language>_<market>' pairings.
language required	string (Language) Enum: "bg" "cs" "da" "de" "el" "en" "es" "et" "fi" "fr" "hu" "id" "it" "ja" "ko" "lt" "lv" "nb" "nl" "pl" "pt" "ro" "ru" "sk" "sl" "sv" "tr" "uk" "zh" The language code for which content is being analysed. Available '<language>_<market>' pairings.
product_desc required	string non-empty A description of the product being summarised.
output_id required	string non-empty The ID to store the generated Review Summaries report under.
review_texts	Array of strings [ 1 .. 1000 ] characters The list of review texts to be summarised. Note: Only the first 200 reviews will be used to identify highlights and shopping barriers.
product_ids	Array of strings The list of product IDs associated with the reviews. Note: Only product_ids or review_texts should be provided, not both.
callback_url	string <uri> (Callback URL) non-empty The URL is called whenever there are changes in the job status, providing real-time updates on progress or completion.

Responses

Callbacks

Request samples

Payload

Content type

application/json

Example

With Review Texts and no Product IDs

Includes giving Review Texts.

This example shows how the user can submit a request where review texts are given via the API.

Note: requests will be rejected if both review_texts and product_ids are given.

{"market": "uk",
"language": "en",
"product_desc": "A fabulous product",
"output_id": "myVirtualProduct",
"review_texts": ["Absolutely love this product! Exceeded my expectations in both quality and functionality. Definitely worth the investment.",
"A bit disappointed with the performance. It works, but not as efficiently as I had hoped. Customer service was quite supportive, though.",
"Average at best. It serves its purpose but lacks any outstanding features. Considering other options for my next purchase.",
"Fantastic product! It's durable, user-friendly, and stylish. Highly recommend for anyone needing a reliable backpack.",
"Not great, not terrible. It's okay for everyday use, but I wouldn't rely on it for heavy-duty activities.",
"Exemplary product with top-notch materials. It's clear a lot of thought went into its design. Love the extra compartments!",
"Mediocre. I had higher expectations given the price. It's decent, but I've seen better for less.",
"This backpack has been a game-changer for my hiking trips. Comfortable, spacious, and withstands all weather conditions.",
"Regrettably, my experience hasn't been positive. The zippers broke within a month of use. Hoping for a smooth return process.",
"Solid choice for a versatile backpack. It fits a lot, feels comfortable on long walks, and looks sleek."
]
}

Response samples

201
400

Content type

application/json

{"job_id": "13d87fb8-a940-447c-9755-dbe6c631ef57"
}

Callback payload samples

Callback

POST: Job Updates

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"status": "completed"
}

Get status for a Review Summariser - Content Analysis job

Retrieve the status of a Review Summariser - Content Analysis job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

Example

Completed

{"status": "completed",
"message": "The job has completed successfully."
}

Get result of a Review Summariser - Content Analysis job

Retrieve the result of a Review Summariser - Content Analysis job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

[{"1. High-quality materials": "8.3%",
"2. Exceeded expectations": "8.3%",
"3. Good customer service": "8.3%",
"4. Great for hiking": "8.3%",
"5. Durable, user-friendly, stylish": "8.3%",
"6. Multiple compartments": "8.3%",
"7. Other": "8.3%"
},
{"1. Overpriced for quality": "8.3%",
"2. Mediocre performance/features": "8.3%",
"3. Poor durability/quality": "8.3%",
"4. Inefficient performance": "8.3%",
"5. Limited heavy-duty use": "8.3%"
}
]

Tone of Voice

Generate a Tone of Voice (Style Guide) using the given Product data.

Submit a job for Tone of Voice - Content Analysis.
Query the status of the job.
Retrieve the generated result.

Submit Tone of Voice - Content Analysis job Deprecated

Entrypoint to submit a job for Tone of Voice - Content Analysis.

Submits a job for to extract the Tone of Voice from the supplied PDP.

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json
required

The parameters for the Tone of Voice - Content Analysis job.

external_tracking_id	string non-empty An optional external job ID to be used for internal tracking purposes.
required	Array of objects [ 1 .. 5 ] items
analysis_model_name	string (LLM Model) non-empty Enum: "gpt-4.1" "gpt-5-chat" The name of the LLM model to be used.
callback_url	string <uri> (Callback URL) non-empty The URL is called whenever there are changes in the job status, providing real-time updates on progress or completion.

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"external_tracking_id": "8a6953e1-cc2b-4be6-8d8b-f0a87daf7334",
"items": [{"product": {"product_id": "0000099999999",
"product_name": "Tester",
"product_description": "Some product description.",
"brand": "satalia_gen",
"market": "uk",
"language": "en",
"variant_group_id": "P9999999",
"keywords": {"title_keywords": ["tester",
"Satalia"
],
"should_keywords": ["VML",
"WPP"
],
"must_keywords": ["AI"
],
"must_not_keywords": ["WTC"
],
"some_keywords_of_my_choice": ["tester"
],
"desc_must_claims": ["A simple claim that is verbatim and must be included within the description",
"'Claim': A verbatim claim that must be included within the description* | 'Disclaimer': *A verbatim disclaimer that corresponds to the 'Claim' and must be included at the end of the description"
],
"desc_optional_claims": ["A simple claim that is non-verbatim and it can optionally be included within the description"
],
"bullets_must_claims": ["A simple claim that is verbatim and must be included within the bullet points",
"'Claim': A verbatim claim that must be included within the bullet point** | 'Disclaimer': **A verbatim disclaimer that corresponds to the 'Claim' and must be included at the end of the bullet point"
],
"bullets_optional_claims": ["A simple claim that is non-verbatim and it can optionally be included within the bullet points"
]
},
"reviews": [{"review_id": "AABBCCDDEEFF123",
"review_text": "It was a great product. Thanks!",
"cust": "satalia"
}
],
"attributes": [{"name": "ean",
"value": "1234567890123"
},
{"name": "hair_type",
"value": "Straight"
},
{"name": "hair_colour",
"value": "Black"
},
{"name": "how_to_use",
"value": "Apply to wet hair, massage into a lather, rinse thoroughly and repeat if desired."
}
]
},
"pdp_contents": [{"title": "High Performance Laptop",
"desc": "Designed for ultimate performance and versatility",
"howtouse": "Simply plug in and power up for an enhanced computing experience",
"bullets": ["16GB RAM for seamless multitasking.",
"512GB SSD for fast storage and boot times."
]
}
]
}
],
"analysis_model_name": "gpt-4.1",
"callback_url": "https://example.com/webhook-url"
}

Response samples

201
400

Content type

application/json

{"job_id": "13d87fb8-a940-447c-9755-dbe6c631ef57"
}

Callback payload samples

Callback

POST: Job Updates

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"status": "completed"
}

Get status for a Tone of Voice - Content Analysis job Deprecated

Retrieve the status of a Tone of Voice - Content Analysis job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

Example

Completed

{"status": "completed",
"message": "The job has completed successfully."
}

Get result of a Tone of Voice - Content Analysis job Deprecated

Retrieve the result of a Tone of Voice - Content Analysis job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

{"tone_of_voice": "string",
"writing_style": "string",
"target_audience": "string",
"grammar": "string",
"emotional_tone": "string",
"punctuation": "string",
"language": "string",
"pitch": "string",
"choice_of_words": "string",
"use_of_emoticons": "string",
"pattern": "string",
"industry": "string"
}

Product Classification

Generate a Product Classification for a given product.

Classify Product Deprecated

Classify a product according to the GPC Schema.

This is based on the GS1's GPC schema available at https://gpc-browser.gs1.org/.
Note: There might be a slight delay between us loading the latest GPC schema and it being for product classification.

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json
required

The parameters for the Product Classification - Content Analysis job.

product_name required	string [ 1 .. 128 ] characters The name of the product to classify.
product_description required	string [ 1 .. 512 ] characters The description of the product to classify.
required	Array of objects (Product Attributes Item) [ 1 .. 16 ] items The attributes of the product. Try to include only relevant attributes (e.g. product type, product category) that are likely to be useful for classification, as too much information can lead to an incorrect classification.

Responses

Request samples

Payload

Content type

application/json

{"product_name": "Generic Brand Voluminous Lash Paradise Washable Mascara",
"product_description": "Revolutionary formula with intense volume and spectacular length.",
"product_attributes": [{"name": "product_types",
"value": "Mascara"
},
{"name": "category",
"value": "Beauty"
}
]
}

Response samples

200
400
422

Content type

application/json

{"segment": {"code": 53000000,
"title": "Beauty/Personal Care/Hygiene"
},
"family": {"code": 53160000,
"title": "Cosmetics/Fragrances"
},
"class": {"code": 53161000,
"title": "Cosmetic/makeup Products"
},
"brick": {"code": 10000533,
"title": "Cosmetic/makeup - Eyes"
}
}

Submit a Product Classification Job

Submits a request to classify a product based on the target channel and market taxonomy.

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json

external_tracking_id	string non-empty Optional external job ID for internal tracking.
required	object (Product Classification - Product) The product details required for product classification.
channel	string (Product Classification Channel) Default: "gpc" Enum: "gpc" "google" The channel for which the classification is relevant.
	Locale - GPC (string) or Locale - Google (string)
callback_url	string <uri> (Callback URL) non-empty The URL is called whenever there are changes in the job status, providing real-time updates on progress or completion.

Responses

Callbacks

Request samples

Payload

Content type

application/json

Example

GPC (minimum)

A minimal request to classify a product using the GPC taxonomy.

{"product": {"product_name": "Generic Brand Voluminous Lash Paradise Washable Mascara",
"product_description": "Revolutionary formula with intense volume and spectacular length.",
"product_attributes": [{"name": "product_types",
"value": "Mascara"
},
{"name": "category",
"value": "Beauty"
}
]
},
"channel": "gpc"
}

Response samples

202
400

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f"
}

Callback payload samples

Callback

POST: Job Updates

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"status": "completed"
}

Get a Product Classification job

Retrieves the current status and result (if any) of a Product Classification job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string <uuid>

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

Example

GPC Classification

A job that completed successfully with a GPC classification result.

{"status": "completed",
"result": {"classification": {"segment": {"code": 53000000,
"title": "Beauty/Personal Care/Hygiene"
},
"family": {"code": 53160000,
"title": "Cosmetics/Fragrances"
},
"class": {"code": 53161000,
"title": "Cosmetic/MakeUp Products"
},
"brick": {"code": 10000533,
"title": "Cosmetic/MakeUp - Eyes"
},
"attributes": [{"code": 20003181,
"title": "Colour Family",
"values": [{"code": 30009969,
"title": "MULTICOLOURED"
},
{"code": 30018998,
"title": "SHADES OF BEIGE"
},
{"code": 30018995,
"title": "SHADES OF BLACK"
},
{"code": 30018989,
"title": "SHADES OF BLUE"
},
{"code": 30018997,
"title": "SHADES OF BROWN"
},
{"code": 30018990,
"title": "SHADES OF GREEN"
},
{"code": 30018994,
"title": "SHADES OF GREY"
},
{"code": 30018992,
"title": "SHADES OF ORANGE"
},
{"code": 30018988,
"title": "SHADES OF PINK"
},
{"code": 30018993,
"title": "SHADES OF PURPLE"
},
{"code": 30018987,
"title": "SHADES OF RED"
},
{"code": 30018996,
"title": "SHADES OF WHITE"
},
{"code": 30018991,
"title": "SHADES OF YELLOW"
},
{"code": 30002515,
"title": "UNCLASSIFIED"
},
{"code": 30002518,
"title": "UNIDENTIFIED"
}
]
},
{"code": 20000312,
"title": "Dispenser Type",
"values": [{"code": 30007434,
"title": "BRUSH"
},
{"code": 30019043,
"title": "JAR"
},
{"code": 30017205,
"title": "PAD"
},
{"code": 30019044,
"title": "PALETTE"
},
{"code": 30007664,
"title": "PEN"
},
{"code": 30004198,
"title": "ROLL ON"
},
{"code": 30002314,
"title": "SPONGE"
},
{"code": 30004265,
"title": "STICK"
},
{"code": 30003699,
"title": "STORAGE BOTTLE"
},
{"code": 30004325,
"title": "TUBE"
},
{"code": 30002515,
"title": "UNCLASSIFIED"
},
{"code": 30002518,
"title": "UNIDENTIFIED"
}
]
},
{"code": 20000352,
"title": "Formation",
"values": [{"code": 30000077,
"title": "CREAM"
},
{"code": 30003945,
"title": "GEL"
},
{"code": 30001448,
"title": "LIQUID"
},
{"code": 30004031,
"title": "LOTION"
},
{"code": 30017267,
"title": "MILK (COSMETICS)"
},
{"code": 30006699,
"title": "MOUSSE/FOAM"
},
{"code": 30001717,
"title": "OIL"
},
{"code": 30001909,
"title": "POWDER"
},
{"code": 30011783,
"title": "POWDER - COMPACT"
},
{"code": 30017269,
"title": "SERUM"
},
{"code": 30002265,
"title": "SOLID"
},
{"code": 30002515,
"title": "UNCLASSIFIED"
},
{"code": 30002518,
"title": "UNIDENTIFIED"
},
{"code": 30004365,
"title": "WIPE"
}
]
},
{"code": 20000658,
"title": "If Waterproof",
"values": [{"code": 30002960,
"title": "NO"
},
{"code": 30002518,
"title": "UNIDENTIFIED"
},
{"code": 30002654,
"title": "YES"
}
]
},
{"code": 20003191,
"title": "Product Usage Body Location",
"values": [{"code": 30006682,
"title": "EYE AREA (EYES)"
},
{"code": 30019053,
"title": "EYE BROW (BROWS)"
},
{"code": 30002515,
"title": "UNCLASSIFIED"
},
{"code": 30002518,
"title": "UNIDENTIFIED"
}
]
},
{"code": 20000366,
"title": "Target Gender",
"values": [{"code": 30003891,
"title": "FEMALE"
},
{"code": 30004039,
"title": "MALE"
},
{"code": 30002515,
"title": "UNCLASSIFIED"
},
{"code": 30002518,
"title": "UNIDENTIFIED"
},
{"code": 30004340,
"title": "UNISEX"
}
]
},
{"code": 20000638,
"title": "Type of Cosmetics - Eyes",
"values": [{"code": 30000720,
"title": "COMBINATION"
},
{"code": 30011786,
"title": "EYE BROW PENCIL"
},
{"code": 30003851,
"title": "EYE BROW STYLING GEL"
},
{"code": 30003853,
"title": "EYE HIGHLIGHTER/ILLUMINATOR"
},
{"code": 30003855,
"title": "EYE LASH THICKENER"
},
{"code": 30003856,
"title": "EYE LINER"
},
{"code": 30003858,
"title": "EYE PENCIL"
},
{"code": 30003859,
"title": "EYE SHADOW"
},
{"code": 30003860,
"title": "EYE SHADOW PRIMER"
},
{"code": 30003861,
"title": "EYE SHADOW SEALER"
},
{"code": 30005965,
"title": "MASCARA"
},
{"code": 30004041,
"title": "MASCARA SEALER"
},
{"code": 30002515,
"title": "UNCLASSIFIED"
},
{"code": 30002518,
"title": "UNIDENTIFIED"
}
]
},
{"code": 20000719,
"title": "If Impregnated",
"values": [{"code": 30002960,
"title": "NO"
},
{"code": 30002518,
"title": "UNIDENTIFIED"
},
{"code": 30002654,
"title": "YES"
}
]
}
]
},
"channel": "gpc",
"locale": "en-GB",
"version": "2024-06-01",
"confidence": 0.91
}
}

Channel Adaptation

Generate content for a new channel based on the given examples.

Submit a job for Channel - Content Adaptation
Query the status of the job.
Retrieve the generated result.
Retrieve the Content Configuration used for the job.

Submit Channel - Content Adaptation job

Entrypoint to submit a job for Channel - Content Adaptation.

Submits a job for to adapt the given content based on the given PDPs in the target channel.

The content_types that will be generated are explained in our User Guide - Content Generator and Channel Adaptation Functionalities - Channel Adaptation.

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json
required

The parameters for the Channel - Content Adaptation job.

external_tracking_id	string non-empty An optional external job ID to be used for internal tracking purposes.
required	Array of objects (Channel Content Adaptation Item) non-empty The product and PDP pairings for adaptation.
required	object Parameters for the Content Generation job.
adaptation_model_name	string (Channel Content Adaptation LLM Model) non-empty Default: "gpt-4.1" Value: "gpt-4.1" The name of the LLM model to be used.
callback_url	string <uri> (Callback URL) non-empty The URL is called whenever there are changes in the job status, providing real-time updates on progress or completion.

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"external_tracking_id": "8a6953e1-cc2b-4be6-8d8b-f0a87daf7334",
"items": [{"product": {"product_id": "1234567890001",
"product_name": "QuantumTech Gadget",
"product_description": "A high-tech gadget designed for modern needs.",
"brand": "QuantumTech",
"market": "uk",
"language": "en",
"variant_group_id": "G123456",
"keywords": {"generic": ["tech",
"gadget"
],
"title": ["Quantum",
"Tech"
],
"avoid": ["obsolete"
]
},
"reviews": [{"review_id": "XYZ987654321",
"review_text": "An innovative product that exceeded my expectations!",
"cust": "techguru"
}
],
"attributes": [{"name": "long_product_name",
"value": "Some Gadget"
},
{"name": "brand",
"value": "QuantumTech"
},
{"name": "colour",
"value": "Black"
}
]
},
"initial_pdp_content": {"title": "QuantumTech Gadget",
"desc": "A high-tech gadget designed for modern needs.",
"bullets": ["High-speed processor",
"Modern and sleek design",
"Long-lasting battery",
"Advanced connectivity"
],
"howtouse": "Turn on the device and follow the initial setup instructions."
},
"pdp_content": {"title": "QuantumTech Gadget 2024 Edition",
"desc": "Experience the cutting-edge technology with QuantumTech Gadget 2024 Edition, perfect for tech enthusiasts and professionals alike.",
"bullets": ["High-performance processor",
"Sleek, modern design",
"Long-lasting battery life",
"Advanced connectivity options",
"Compatible with latest software"
],
"howtouse": "To operate, simply press the power button and follow the on-screen instructions."
}
}
],
"content_generation_params": {"market": "uk",
"language": "en",
"channel": "Amazon",
"source_channel": "Standard",
"channel_examples": [{"product_id": "1234567890123",
"source": {"title": "QuantumTech Gadget 2023 Edition",
"desc": "Explore the innovative features of the QuantumTech Gadget 2023 Edition.",
"bullets": ["High-speed processor",
"Modern and sleek design",
"Long-lasting battery",
"Advanced connectivity"
],
"howtouse": "Turn on the device and follow the initial setup instructions."
},
"target": {"title": "QuantumTech Gadget 2024 Edition",
"desc": "Experience the cutting-edge technology with QuantumTech Gadget 2024 Edition, perfect for tech enthusiasts and professionals alike.",
"bullets": ["High-performance processor",
"Sleek, modern design",
"Long-lasting battery life",
"Advanced connectivity options",
"Compatible with latest software"
],
"howtouse": "To operate, simply press the power button and follow the on-screen instructions."
}
}
],
"content_config": {"guidelines": ["Ensure high-quality product titles.",
"Use bullet points to highlight key features."
],
"restrictions": ["Avoid any use of special characters in titles."
]
}
},
"adaptation_model_name": "gpt-4.1",
"callback_url": "https://api.example.com/callback"
}

Response samples

201
400
409

Content type

application/json

{"job_id": "13d87fb8-a940-447c-9755-dbe6c631ef57"
}

Callback payload samples

Callback

POST: Job Updates

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"status": "completed"
}

Get status for a Channel - Content Adaptation job

Retrieve the status of a Channel - Content Adaptation job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

Example

Completed

{"status": "completed",
"message": "The job has completed successfully."
}

Get result of a Channel - Content Adaptation job

Retrieve the result of a Channel - Content Adaptation job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

Example

Successfully Adapted Content

Channel - Content Adaptation was successful for one Product.

{"01234567": {"content": {"title": "This is a test title.",
"desc": "This is a description lorem ipsum dolor sit amet."
},
"product": {"product_id": "01234567",
"product_name": "Tester",
"product_description": "Some product description.",
"brand": "satalia_gen",
"market": "uk",
"language": "en",
"variant_group_id": "P9999999",
"keywords": {"title": ["tester",
"Satalia"
]
},
"reviews": [{"review_id": "3G7H2Qf4R5pE8Jw8",
"review_text": "It was a great product. Thanks!",
"cust": "satalia"
}
],
"attributes": [{"name": "ean",
"value": "01234567"
}
]
},
"warnings": [{"content_type": "title",
"code": "EXCEED_LENGTH",
"description": "title exceeds length by 21 characters"
},
{"content_type": "desc",
"code": "EXCEED_LENGTH",
"description": "desc exceeds length by 11 characters"
}
]
}
}

Get Content Configuration for a Channel - Content Adaptation job

Retrieve the Content Configuration for a Channel - Content Adaptation job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string <uuid>

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

{"guidelines": ["This is a guideline."
],
"guidelines_shortener": ["This is a shortener guideline."
],
"restrictions": ["This is a restriction."
],
"word_map": {"Foo": "Bar"
},
"tone": {"SomeBrand": {"SomeToneKey": "SomeToneValue"
}
},
"keyword_groups": {"should": ["generic_keyword",
"product_category_keyword"
],
"omit": ["word_to_avoid"
]
},
"client": {"prompt_attributes": ["Long Product Name",
"Brand",
"Colour"
],
"forbidden_words": ["shopper barrier",
"shopping barrier"
],
"content_type_family_map": {"title": "title",
"bullets": "bullets",
"desc": "string",
"short_title": "title",
"long_title": "title",
"short_desc": "string"
},
"field_map": {"short_description": "Sub Category",
"reviews": "Reviews",
"brand": "Brand",
"long_product_name": "Long Product Name"
},
"validation_entities": ["PRODUCT_NAME",
"SIZE"
],
"false_words_entity_map": {"COLOR": "Colour",
"SIZE": "Size"
},
"review_attributes": ["Reviews",
"Positive reviews"
],
"variant_data_fields": ["Colour",
"Effect"
],
"tone_content_types": ["bullets",
"short_bullets",
"desc",
"short_desc"
],
"skip_content_types": ["title",
"howtouse"
]
},
"content_types": {"title": {"task": "Write a title for the product...",
"character_limit": 100,
"guidelines": ["This is a good guideline."
],
"guidelines_shortener": ["This is a shortener good guideline."
],
"restrictions": ["This is a good restriction."
],
"additions": {"title": "{{attr.brand}}, {{title}}, {{attr.sub_brand}}"
},
"keyword_groups": {"must": ["title_keyword"
]
}
},
"desc": {"task": "Write a description for the product...",
"character_limit": 1000,
"keyword_groups": {"should": ["description_keyword"
]
}
},
"bullets": {"task": "Write some bullets for the product...",
"character_limit": 250,
"additions": {"bullets_1": "How to: {{bullets_1}}",
"bullets_3": "Ingredients: {{bullets_3}}"
}
}
}
}

Tone of Voice

Apply a Tone of Voice (Style Guide) to the given Product data.

Submit a job for Tone of Voice - Content Adaptation.
Query the status of the job.
Retrieve the generated result.

Submit Tone of Voice - Content Adaptation job

Entrypoint to submit a job for Tone of Voice - Content Adaptation.

Submits a job for to adapt the given content using the given Tone of Voice.

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json
required

The parameters for the Tone of Voice - Content Adaptation job.

external_tracking_id	string non-empty An optional external job ID to be used for internal tracking purposes.
required	object or null (Style Guide) A Style Guide for Tone of Voice.
required	object (PDP Content) The PDP (Product Detail Page) content provided is a schema for presenting detailed information about a specific product. It represents the content as a structured array, where each key defines a content type (e.g., title, description) and its corresponding value provides the associated content.
adaptation_model_name	string (LLM Model) non-empty Default: "gpt-4.1" Enum: "gpt-4.1" "gpt-5-chat" The name of the LLM model to be used.
callback_url	string <uri> (Callback URL) non-empty The URL is called whenever there are changes in the job status, providing real-time updates on progress or completion.

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"external_tracking_id": "5f13f180-7ef0-41d0-ab70-1e3d7ab864c9",
"style_guide": {"tone_of_voice": "Informal but professional",
"writing_style": "Simple and concise",
"target_audience": "General audience",
"grammar": "Correct usage of grammar and punctuation",
"emotional_tone": "Neutral",
"punctuation": "Limited use of commas and full stops.",
"language": "Easy to understand language. Avoid using jargon and complex words.",
"pitch": "Positive and optimistic",
"choice_of_words": "Use simple words and phrases. Avoid using slang or offensive language.",
"use_of_emoticons": "Emoticons can be used in informal communications but not in professional communications.",
"pattern": "Use short paragraphs and bullet points for better readability.",
"industry": "General"
},
"content": {"title": "This is a test title.",
"desc": "This is a description lorem ipsum dolor sit amet.",
"howtouse": "This is how to use lorem ipsum dolor sit amet.",
"bullets": ["bullet1",
"bullet2",
"bullet3"
]
},
"adaptation_model_name": "gpt-4.1"
}

Response samples

201
400

Content type

application/json

{"job_id": "13d87fb8-a940-447c-9755-dbe6c631ef57"
}

Callback payload samples

Callback

POST: Job Updates

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"status": "completed"
}

Get status for a Tone of Voice - Content Adaptation job

Retrieve the status of a Tone of Voice - Content Adaptation job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

Example

Completed

{"status": "completed",
"message": "The job has completed successfully."
}

Get result of a Tone of Voice - Content Adaptation job

Retrieve the result of a Tone of Voice - Content Adaptation job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

{"title": "This is a test title.",
"desc": "This is a description lorem ipsum dolor sit amet."
}

Translation

Translate the given content into the given target language(s).

Submit Translation job - Content Adaptation
Get status of a translation job
Get result of a translation job

Submit translation job - Content Adaptation

Initiates a translation job to adapt product detail page (PDP) content from English to specified target languages. The request includes the content and list of target languages.

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json
required

The following parameters must be defined to translate PDP content into desired language

external_tracking_id	string non-empty Tracks the translation job with an optional external job ID, allowing seamless internal tracking.
required	object (PDP Content) The PDP (Product Detail Page) content provided is a schema for presenting detailed information about a specific product. It represents the content as a structured array, where each key defines a content type (e.g., title, description) and its corresponding value provides the associated content.
languages required	Array of arrays [ 1 .. 5 ] items Specifies the target languages for adapting the PDP content. You can specify upto 5 target languages for translation. Available languages
	object Provides a custom map of keyword translations, replacing automatic translations where needed for greater accuracy and contextual relevance. Available languages
translation_model_name	string (LLM Model) non-empty Default: "gpt-4.1" Enum: "gpt-4.1" "gpt-5-chat" The name of the LLM model to be used.
callback_url	string <uri> (Callback URL) non-empty The URL is called whenever there are changes in the job status, providing real-time updates on progress or completion.

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"external_tracking_id": "8a6953e1-cc2b-4be6-8d8b-f0a87daf7334",
"pdp_content": {"title": "High Performance Laptop",
"desc": "Designed for ultimate performance and versatility",
"howtouse": "Simply plug in and power up for an enhanced computing experience",
"bullets": ["16GB RAM for seamless multitasking.",
"512GB SSD for fast storage and boot times."
]
},
"languages": ["fr_FR",
"es_ES"
],
"translated_keywords": {"fr_FR": {"performance": "performance",
"laptop": "ordinateur portable"
},
"id_ID": {"performance": "rendimiento",
"laptop": "ordenador portátil"
}
},
"translation_model_name": "gpt-4.1",
"callback_url": "https://example.com/webhook-url"
}

Response samples

201
400
413

Content type

application/json

{"job_id": "13d87fb8-a940-447c-9755-dbe6c631ef57"
}

Callback payload samples

Callback

POST: Job Updates

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"status": "completed"
}

Get status for a Translation - Content Adaptation job

Retrieve the status of a Translation - Content Adaptation job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

Example

Completed

{"status": "completed",
"message": "The job has completed successfully."
}

Get result of a Translation - Content Adaptation job

Retrieve the result of a Translation - Content Adaptation job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

[{"language": "Spanish (Spain)",
"pdp_content": {"title": "lorem ipsum dolor sit amet",
"desc": "lorem ipsum dolor sit amet.",
"howtouse": "lorem ipsum dolor sit amet.",
"bullets": ["lorem ipsum dolor sit amet.",
"lorem ipsum dolor sit amet."
]
},
"warnings": [{"content_type": "title",
"code": "EXCEED_LENGTH",
"description": "title exceeds length by 21 characters"
}
]
},
{"language": "French (France)",
"pdp_content": {"title": "lorem ipsum dolor sit amet",
"desc": "lorem ipsum dolor sit amet.",
"howtouse": "lorem ipsum dolor sit amet.",
"bullets": ["lorem ipsum dolor sit amet.",
"lorem ipsum dolor sit amet."
]
},
"warnings": [ ]
},
{"language": "German (Germany)",
"pdp_content": {"title": "lorem ipsum dolor sit amet",
"desc": "lorem ipsum dolor sit amet.",
"howtouse": "lorem ipsum dolor sit amet.",
"bullets": ["lorem ipsum dolor sit amet.",
"lorem ipsum dolor sit amet."
]
},
"warnings": [ ]
}
]

Content Configuration Management

Manage the Content Configuration.

Get a list of stored Content Configurations.
Store a new Content Configurations.
Get a stored Content Configuration.
Delete a stored Content Configuration.

List Content Configurations

Lists the Content Configurations

A maximum of 100 configurations will be returned.

Authorizations:

ApiGatewayApiKey

query Parameters

scope

string (Config Scope) non-empty

Enum: "PUBLIC" "PRIVATE"

Example: scope=PRIVATE

The scope of the configuration.

All configs created by a user are PRIVATE.
PUBLIC configs are those created by the system and cannot be updated or deleted.

If no scope is provided, the endpoint will return all configs available for the client across all scopes.

Responses

Response samples

200
400

Content type

application/json

[{"config_id": "d1d31429-d888-4f1c-b9c1-4e842f9bce5b",
"name": "laptops",
"description": "My custom configuration for laptops.",
"scope": "PRIVATE"
}
]

Create Content Configuration

Create a new content configuration.

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json
required

The content configuration details.

name required	string^[a-z]{1,20}$ The name of the configuration.
description	string or null [ 1 .. 256 ] characters An optional description of the configuration.
required	object (Content Config) The content configuration.

Responses

Request samples

Payload

Content type

application/json

{"name": "laptops",
"description": "My custom configuration for laptops.",
"content_config": {"guidelines": ["This is a guideline."
],
"guidelines_shortener": ["This is a shortener guideline."
],
"restrictions": ["This is a restriction."
],
"word_map": {"Foo": "Bar"
},
"tone": {"SomeBrand": {"SomeToneKey": "SomeToneValue"
}
},
"keyword_groups": {"should": ["generic_keyword",
"product_category_keyword"
],
"omit": ["word_to_avoid"
]
},
"client": {"prompt_attributes": ["Long Product Name",
"Brand",
"Colour"
],
"forbidden_words": ["shopper barrier",
"shopping barrier"
],
"content_type_family_map": {"title": "title",
"bullets": "bullets",
"desc": "string",
"short_title": "title",
"long_title": "title",
"short_desc": "string"
},
"field_map": {"short_description": "Sub Category",
"reviews": "Reviews",
"brand": "Brand",
"long_product_name": "Long Product Name"
},
"validation_entities": ["PRODUCT_NAME",
"SIZE"
],
"false_words_entity_map": {"COLOR": "Colour",
"SIZE": "Size"
},
"review_attributes": ["Reviews",
"Positive reviews"
],
"variant_data_fields": ["Colour",
"Effect"
],
"tone_content_types": ["bullets",
"short_bullets",
"desc",
"short_desc"
],
"skip_content_types": ["title",
"howtouse"
]
},
"content_types": {"title": {"task": "Write a title for the product...",
"character_limit": 100,
"guidelines": ["This is a good guideline."
],
"guidelines_shortener": ["This is a shortener good guideline."
],
"restrictions": ["This is a good restriction."
],
"additions": {"title": "{{attr.brand}}, {{title}}, {{attr.sub_brand}}"
},
"keyword_groups": {"must": ["title_keyword"
]
}
},
"desc": {"task": "Write a description for the product...",
"character_limit": 1000,
"keyword_groups": {"should": ["description_keyword"
]
}
},
"bullets": {"task": "Write some bullets for the product...",
"character_limit": 250,
"additions": {"bullets_1": "How to: {{bullets_1}}",
"bullets_3": "Ingredients: {{bullets_3}}"
}
}
}
}
}

Response samples

201
400

Content type

application/json

{"config_id": "d1d31429-d888-4f1c-b9c1-4e842f9bce5b",
"name": "laptops",
"description": "My custom configuration for laptops.",
"content_config": {"guidelines": ["This is a guideline."
],
"guidelines_shortener": ["This is a shortener guideline."
],
"restrictions": ["This is a restriction."
],
"word_map": {"Foo": "Bar"
},
"tone": {"SomeBrand": {"SomeToneKey": "SomeToneValue"
}
},
"keyword_groups": {"should": ["generic_keyword",
"product_category_keyword"
],
"omit": ["word_to_avoid"
]
},
"client": {"prompt_attributes": ["Long Product Name",
"Brand",
"Colour"
],
"forbidden_words": ["shopper barrier",
"shopping barrier"
],
"content_type_family_map": {"title": "title",
"bullets": "bullets",
"desc": "string",
"short_title": "title",
"long_title": "title",
"short_desc": "string"
},
"field_map": {"short_description": "Sub Category",
"reviews": "Reviews",
"brand": "Brand",
"long_product_name": "Long Product Name"
},
"validation_entities": ["PRODUCT_NAME",
"SIZE"
],
"false_words_entity_map": {"COLOR": "Colour",
"SIZE": "Size"
},
"review_attributes": ["Reviews",
"Positive reviews"
],
"variant_data_fields": ["Colour",
"Effect"
],
"tone_content_types": ["bullets",
"short_bullets",
"desc",
"short_desc"
],
"skip_content_types": ["title",
"howtouse"
]
},
"content_types": {"title": {"task": "Write a title for the product...",
"character_limit": 100,
"guidelines": ["This is a good guideline."
],
"guidelines_shortener": ["This is a shortener good guideline."
],
"restrictions": ["This is a good restriction."
],
"additions": {"title": "{{attr.brand}}, {{title}}, {{attr.sub_brand}}"
},
"keyword_groups": {"must": ["title_keyword"
]
}
},
"desc": {"task": "Write a description for the product...",
"character_limit": 1000,
"keyword_groups": {"should": ["description_keyword"
]
}
},
"bullets": {"task": "Write some bullets for the product...",
"character_limit": 250,
"additions": {"bullets_1": "How to: {{bullets_1}}",
"bullets_3": "Ingredients: {{bullets_3}}"
}
}
}
},
"scope": "PRIVATE",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Content Configuration

Retrieves a Content Configuration by the specified config_id.

Authorizations:

ApiGatewayApiKey

path Parameters

config_id

required

string <uuid> non-empty

The unique identifier for the configuration.

Responses

Response samples

200
400
404

Content type

application/json

{"config_id": "d1d31429-d888-4f1c-b9c1-4e842f9bce5b",
"name": "laptops",
"description": "My custom configuration for laptops.",
"content_config": {"guidelines": ["This is a guideline."
],
"guidelines_shortener": ["This is a shortener guideline."
],
"restrictions": ["This is a restriction."
],
"word_map": {"Foo": "Bar"
},
"tone": {"SomeBrand": {"SomeToneKey": "SomeToneValue"
}
},
"keyword_groups": {"should": ["generic_keyword",
"product_category_keyword"
],
"omit": ["word_to_avoid"
]
},
"client": {"prompt_attributes": ["Long Product Name",
"Brand",
"Colour"
],
"forbidden_words": ["shopper barrier",
"shopping barrier"
],
"content_type_family_map": {"title": "title",
"bullets": "bullets",
"desc": "string",
"short_title": "title",
"long_title": "title",
"short_desc": "string"
},
"field_map": {"short_description": "Sub Category",
"reviews": "Reviews",
"brand": "Brand",
"long_product_name": "Long Product Name"
},
"validation_entities": ["PRODUCT_NAME",
"SIZE"
],
"false_words_entity_map": {"COLOR": "Colour",
"SIZE": "Size"
},
"review_attributes": ["Reviews",
"Positive reviews"
],
"variant_data_fields": ["Colour",
"Effect"
],
"tone_content_types": ["bullets",
"short_bullets",
"desc",
"short_desc"
],
"skip_content_types": ["title",
"howtouse"
]
},
"content_types": {"title": {"task": "Write a title for the product...",
"character_limit": 100,
"guidelines": ["This is a good guideline."
],
"guidelines_shortener": ["This is a shortener good guideline."
],
"restrictions": ["This is a good restriction."
],
"additions": {"title": "{{attr.brand}}, {{title}}, {{attr.sub_brand}}"
},
"keyword_groups": {"must": ["title_keyword"
]
}
},
"desc": {"task": "Write a description for the product...",
"character_limit": 1000,
"keyword_groups": {"should": ["description_keyword"
]
}
},
"bullets": {"task": "Write some bullets for the product...",
"character_limit": 250,
"additions": {"bullets_1": "How to: {{bullets_1}}",
"bullets_3": "Ingredients: {{bullets_3}}"
}
}
}
},
"scope": "PRIVATE",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Content Configuration

Delete a Content Configuration by the specified config_id.

Authorizations:

ApiGatewayApiKey

path Parameters

config_id

required

string <uuid> non-empty

The unique identifier for the configuration.

Responses

Response samples

400
404

Content type

application/json

Example

Error Response

{"code": "string",
"message": "string",
"detail": { }
}

Merge Content Configurations

Merge Content Configurations.

Submit a merge Content Configurations job.
Get the status of a merge Content Configurations job.
Retrieve the result of a merge Content Configurations job.

Submit merge Content Configurations job

Merge multiple Content Configurations into a single configuration.

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json
required

The content configuration details.

external_tracking_id	string non-empty An optional external job ID to be used for internal tracking purposes.
required	Array of Content Config (object) or Content Config ID (string) (Content Config Array) [ 2 .. 5 ] items Multiple content configurations to be used.
callback_url	string <uri> (Callback URL) non-empty The URL is called whenever there are changes in the job status, providing real-time updates on progress or completion.

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"external_tracking_id": "8a6953e1-cc2b-4be6-8d8b-f0a87daf7334",
"content_config": [{"guidelines": ["This is a guideline."
],
"guidelines_shortener": ["This is a shortener guideline."
],
"restrictions": ["This is a restriction."
],
"word_map": {"Foo": "Bar"
},
"tone": {"SomeBrand": {"SomeToneKey": "SomeToneValue"
}
},
"keyword_groups": {"should": ["generic_keyword",
"product_category_keyword"
],
"omit": ["word_to_avoid"
]
},
"client": {"prompt_attributes": ["Long Product Name",
"Brand",
"Colour"
],
"forbidden_words": ["shopper barrier",
"shopping barrier"
],
"content_type_family_map": {"title": "title",
"bullets": "bullets",
"desc": "string",
"short_title": "title",
"long_title": "title",
"short_desc": "string"
},
"field_map": {"short_description": "Sub Category",
"reviews": "Reviews",
"brand": "Brand",
"long_product_name": "Long Product Name"
},
"validation_entities": ["PRODUCT_NAME",
"SIZE"
],
"false_words_entity_map": {"COLOR": "Colour",
"SIZE": "Size"
},
"review_attributes": ["Reviews",
"Positive reviews"
],
"variant_data_fields": ["Colour",
"Effect"
],
"tone_content_types": ["bullets",
"short_bullets",
"desc",
"short_desc"
],
"skip_content_types": ["title",
"howtouse"
]
},
"content_types": {"title": {"task": "Write a title for the product...",
"character_limit": 100,
"guidelines": ["This is a good guideline."
],
"guidelines_shortener": ["This is a shortener good guideline."
],
"restrictions": ["This is a good restriction."
],
"additions": {"title": "{{attr.brand}}, {{title}}, {{attr.sub_brand}}"
},
"keyword_groups": {"must": ["title_keyword"
]
}
},
"desc": {"task": "Write a description for the product...",
"character_limit": 1000,
"keyword_groups": {"should": ["description_keyword"
]
}
},
"bullets": {"task": "Write some bullets for the product...",
"character_limit": 250,
"additions": {"bullets_1": "How to: {{bullets_1}}",
"bullets_3": "Ingredients: {{bullets_3}}"
}
}
}
},
"8a6953e1-cc2b-4be6-8d8b-f0a87daf7334"
],
"callback_url": "https://example.com/webhook-url"
}

Response samples

201
400

Content type

application/json

{"job_id": "13d87fb8-a940-447c-9755-dbe6c631ef57"
}

Callback payload samples

Callback

POST: Job Updates

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"status": "completed"
}

Get merge Content Configurations job status

Retrieve the status of a merge Content Configurations job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
404

Content type

application/json

Example

Completed

{"status": "completed",
"message": "The job has completed successfully."
}

Get merge Content Configurations job result

Retrieve the result of a merge Content Configurations job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
404

Content type

application/json

{"content_config": {"guidelines": ["This is a guideline."
],
"guidelines_shortener": ["This is a shortener guideline."
],
"restrictions": ["This is a restriction."
],
"word_map": {"Foo": "Bar"
},
"tone": {"SomeBrand": {"SomeToneKey": "SomeToneValue"
}
},
"keyword_groups": {"should": ["generic_keyword",
"product_category_keyword"
],
"omit": ["word_to_avoid"
]
},
"client": {"prompt_attributes": ["Long Product Name",
"Brand",
"Colour"
],
"forbidden_words": ["shopper barrier",
"shopping barrier"
],
"content_type_family_map": {"title": "title",
"bullets": "bullets",
"desc": "string",
"short_title": "title",
"long_title": "title",
"short_desc": "string"
},
"field_map": {"short_description": "Sub Category",
"reviews": "Reviews",
"brand": "Brand",
"long_product_name": "Long Product Name"
},
"validation_entities": ["PRODUCT_NAME",
"SIZE"
],
"false_words_entity_map": {"COLOR": "Colour",
"SIZE": "Size"
},
"review_attributes": ["Reviews",
"Positive reviews"
],
"variant_data_fields": ["Colour",
"Effect"
],
"tone_content_types": ["bullets",
"short_bullets",
"desc",
"short_desc"
],
"skip_content_types": ["title",
"howtouse"
]
},
"content_types": {"title": {"task": "Write a title for the product...",
"character_limit": 100,
"guidelines": ["This is a good guideline."
],
"guidelines_shortener": ["This is a shortener good guideline."
],
"restrictions": ["This is a good restriction."
],
"additions": {"title": "{{attr.brand}}, {{title}}, {{attr.sub_brand}}"
},
"keyword_groups": {"must": ["title_keyword"
]
}
},
"desc": {"task": "Write a description for the product...",
"character_limit": 1000,
"keyword_groups": {"should": ["description_keyword"
]
}
},
"bullets": {"task": "Write some bullets for the product...",
"character_limit": 250,
"additions": {"bullets_1": "How to: {{bullets_1}}",
"bullets_3": "Ingredients: {{bullets_3}}"
}
}
}
},
"warnings": [{ }
]
}

Channel Management

Manage the configuration for channels.

Get the content types list for the given channel and locale.
Get a list of available channels.

Get content types for a channel/locale pair

Retrieve the content types allowed for a specific channel/locale pair.

Authorizations:

ApiGatewayApiKey

path Parameters

channel required	string Example: channel The ID of the channel.
locale required	string Example: en_uk The locale of the channel.

Responses

Response samples

200
400
404

Content type

application/json

["title",
"desc",
"bullets"
]

Get list of available channels

Retrieve list of all available channels (and associated locales).

Authorizations:

ApiGatewayApiKey

Responses

Response samples

200
400

Content type

application/json

{"en_uk": ["standard",
"amazon"
],
"de_de": ["standard"
]
}

Job Management

Manage the jobs.

Get the list of jobs.

List all jobs

Retrieve all the jobs that have been submitted by a client.

Authorizations:

ApiGatewayApiKey

query Parameters

page_token

string non-empty

Optional starting point (page token returned in previous request) for listing jobs.

Responses

Response samples

200
400

Content type

application/json

{"items": [{"job_id": "13d87fb8-a940-447c-9755-dbe6c631ef57",
"job_creation_date": "2024-01-01T12:00:00",
"status": "completed"
},
{"job_id": "13d87fb8-a940-447c-9755-dbe6c631ef58",
"job_creation_date": "2024-01-01T12:00:00",
"status": "processing"
}
],
"next_page_token": "eyJqb2JfaWQiOiAiNGI5Njc3ZjktMTY2YS00ZmE3LTk5YjctODg4YWMxNzZmNmE0IiwgImNsaWVudF9pZCI6ICJhbHRlcm5hdGl2ZSIsICJqb2JfY3JlYXRpb25fZGF0ZSI6ICIyMDI0LTA5LTE5VDE0OjEzOjQxIn0"
}

Product

product_id required	string non-empty The unique identifier for the product.
product_name required	string non-empty The name of the product.
product_description required	string non-empty A description of the product.
brand required	string non-empty The brand of the product, e.g. `nike`. This is used to lookup the brand in the brand taxonomy. Is not to appear in the content.
market required	string non-empty The market of the product, e.g. `uk`. This is used to lookup the market in the market taxonomy. Is not to appear in the content.
language required	string non-empty The language of the product, e.g. `en`. This is used to specify which language to use when generating the content.
variant_group_id required	string non-empty The variant group ID of the product. This is used to group products together that are variants of each other. For example, a t-shirt that comes in different sizes and colours would have the same `variant_group_id`. This is used to ensure that the content generated for each variant is similar. When providing variants, ensure that the first 'product' (first value in `product` or `product_ids`) is the primary/master 'product'.
	object Keywords for the product. All the keywords are grouped by keyword groups. Groups are used to determine how the keyword should be used. Within keywords, Legal Claims/Disclaimers can be provided to be added to the description and bullet points of the product. Legal Claims are divided into must and optional Claims. Must Claims are verbatim, while optional Claims are non-verbatim. For more information, see our User Guide - Keywords - Claims/Disclaimers.
	Array of objects Reviews for the product. Note: Only the first 200 reviews will be used to identify highlights and shopping barriers.
required	Array of objects non-empty Attributes for the product. These arbitrary attributes that are used to generate the content. For example, the attribute `ean` could be used to generate the content, they are attributes that are very specific to the product type.

{"product_id": "0000099999999",
"product_name": "Tester",
"product_description": "Some product description.",
"brand": "satalia_gen",
"market": "uk",
"language": "en",
"variant_group_id": "P9999999",
"keywords": {"title_keywords": ["tester",
"Satalia"
],
"should_keywords": ["VML",
"WPP"
],
"must_keywords": ["AI"
],
"must_not_keywords": ["WTC"
],
"some_keywords_of_my_choice": ["tester"
],
"desc_must_claims": ["A simple claim that is verbatim and must be included within the description",
"'Claim': A verbatim claim that must be included within the description* | 'Disclaimer': *A verbatim disclaimer that corresponds to the 'Claim' and must be included at the end of the description"
],
"desc_optional_claims": ["A simple claim that is non-verbatim and it can optionally be included within the description"
],
"bullets_must_claims": ["A simple claim that is verbatim and must be included within the bullet points",
"'Claim': A verbatim claim that must be included within the bullet point** | 'Disclaimer': **A verbatim disclaimer that corresponds to the 'Claim' and must be included at the end of the bullet point"
],
"bullets_optional_claims": ["A simple claim that is non-verbatim and it can optionally be included within the bullet points"
]
},
"reviews": [{"review_id": "AABBCCDDEEFF123",
"review_text": "It was a great product. Thanks!",
"cust": "satalia"
}
],
"attributes": [{"name": "ean",
"value": "1234567890123"
},
{"name": "hair_type",
"value": "Straight"
},
{"name": "hair_colour",
"value": "Black"
},
{"name": "how_to_use",
"value": "Apply to wet hair, massage into a lather, rinse thoroughly and repeat if desired."
}
]
}

PDP Content

additional property

string or Array of strings

{"title": "High Performance Laptop",
"desc": "Designed for ultimate performance and versatility",
"howtouse": "Simply plug in and power up for an enhanced computing experience",
"bullets": ["16GB RAM for seamless multitasking.",
"512GB SSD for fast storage and boot times."
]
}

Content Config

guidelines	Array of strings or null (Guidelines) Guidelines for the content. Guidelines are used to provide instructions for the Content Generation.
guidelines_shortener	Array of strings or null (GuidelinesShortener) Guidelines for when shortening content. Guidelines are used to provide instructions for the Content Generation.
restrictions	Array of strings or null (Restrictions) Restrictions for the content. Restrictions are used to provide restrictions for the Content Generation.
	object or null (Keyword Groups) Mapping of keyword groups to their use in the content. Keyword groups to be used for the content.
	object or null (Word Map) A map of words to be replaced in the content. The key is the word to be replaced and the value is the word to replace with.
	object (Tone) Tone options to be included in the content. Tone options are expected to be 'indexed' by Brand, and then include any key-value pair.
	object or null (Client Config) Mapping of client configuration for Content Generation.
	object or null (Style Guide) A Style Guide for Tone of Voice.
	object (Content Types Config) Specific configuration for each content type.

{"guidelines": ["This is a guideline."
],
"guidelines_shortener": ["This is a shortener guideline."
],
"restrictions": ["This is a restriction."
],
"word_map": {"Foo": "Bar"
},
"tone": {"SomeBrand": {"SomeToneKey": "SomeToneValue"
}
},
"keyword_groups": {"should": ["generic_keyword",
"product_category_keyword"
],
"omit": ["word_to_avoid"
]
},
"client": {"prompt_attributes": ["Long Product Name",
"Brand",
"Colour"
],
"forbidden_words": ["shopper barrier",
"shopping barrier"
],
"content_type_family_map": {"title": "title",
"bullets": "bullets",
"desc": "string",
"short_title": "title",
"long_title": "title",
"short_desc": "string"
},
"field_map": {"short_description": "Sub Category",
"reviews": "Reviews",
"brand": "Brand",
"long_product_name": "Long Product Name"
},
"validation_entities": ["PRODUCT_NAME",
"SIZE"
],
"false_words_entity_map": {"COLOR": "Colour",
"SIZE": "Size"
},
"review_attributes": ["Reviews",
"Positive reviews"
],
"variant_data_fields": ["Colour",
"Effect"
],
"tone_content_types": ["bullets",
"short_bullets",
"desc",
"short_desc"
],
"skip_content_types": ["title",
"howtouse"
]
},
"content_types": {"title": {"task": "Write a title for the product...",
"character_limit": 100,
"guidelines": ["This is a good guideline."
],
"guidelines_shortener": ["This is a shortener good guideline."
],
"restrictions": ["This is a good restriction."
],
"additions": {"title": "{{attr.brand}}, {{title}}, {{attr.sub_brand}}"
},
"keyword_groups": {"must": ["title_keyword"
]
}
},
"desc": {"task": "Write a description for the product...",
"character_limit": 1000,
"keyword_groups": {"should": ["description_keyword"
]
}
},
"bullets": {"task": "Write some bullets for the product...",
"character_limit": 250,
"additions": {"bullets_1": "How to: {{bullets_1}}",
"bullets_3": "Ingredients: {{bullets_3}}"
}
}
}
}

Style Guide (Tone of Voice)

tone_of_voice	string
writing_style	string
target_audience	string
grammar	string
emotional_tone	string
punctuation	string
language	string
pitch	string
choice_of_words	string
use_of_emoticons	string
pattern	string
industry	string

{"tone_of_voice": "string",
"writing_style": "string",
"target_audience": "string",
"grammar": "string",
"emotional_tone": "string",
"punctuation": "string",
"language": "string",
"pitch": "string",
"choice_of_words": "string",
"use_of_emoticons": "string",
"pattern": "string",
"industry": "string"
}

Brand Brain Commerce API (1.12.0)

Introduction

Overview

Validation Process

Background Operations

Job Tracking

Content Generation

Submit Content Generation job

Authorizations:

Request Body schema: application/jsonrequired

Responses

Callbacks

Request samples

Response samples

Callback payload samples

Get Content Generation job status

Authorizations:

path Parameters

Responses

Response samples

Get Content Generation job result

Authorizations:

path Parameters

Responses

Response samples

Get Content Generation job Content Configuration

Authorizations:

path Parameters

Responses

Response samples

Submit Feedback for Content Generation job

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Review Summariser

Submit Review Summariser - Content Analysis job

Authorizations:

Request Body schema: application/jsonrequired

Responses

Callbacks

Request samples

Response samples

Callback payload samples

Get status for a Review Summariser - Content Analysis job

Authorizations:

path Parameters

Responses

Response samples

Get result of a Review Summariser - Content Analysis job

Authorizations:

path Parameters

Responses

Response samples

Tone of Voice

Submit Tone of Voice - Content Analysis job Deprecated

Authorizations:

Request Body schema: application/jsonrequired

Responses

Callbacks

Request samples

Response samples

Callback payload samples

Get status for a Tone of Voice - Content Analysis job Deprecated

Authorizations:

path Parameters

Responses

Response samples

Get result of a Tone of Voice - Content Analysis job Deprecated

Authorizations:

path Parameters

Responses

Response samples

Product Classification

Classify Product Deprecated

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required