JSON AI Review Summaries API

The JSON AI Review Summaries API allows you to access AI-generated summaries of reviews collected for your products.

Accessing AI summaries

Note: The JSON AI Review Summaries API must be enabled by TestFreaks for your client ID.

The API takes your client ID, and either the product ID or the family ID.

Using a product ID:

https://cr.testfreaks.com/ai-summaries.json?client_id=your.client.id&product_id=PRODUCT001

Using a family ID:

https://cr.testfreaks.com/ai-summaries.json?client_id=your.client.id&family_id=FAMILY001

Note: The your.client.id part should be replaced with one of your assigned client IDs.

See Product Feed for an explanation of the product and family concepts.

The API returns a JSON response that always contains the following fields:

  • content: the AI-generated summary, typically a few sentences of text
  • number_of_reviews: the number of reviews used for the summary
  • generated_at: the date and time when the summary was generated, formatted as an ISO 8601 UTC timestamp.

Example response:

{
  "content": "The product reviews are summarized in a few sentences.",
  "number_of_reviews": 73,
  "generated_at": "2025-03-18T08:08:39Z"
}