Entities

Recognizable items — products, brands, tools, and concepts — that cloro lifts out of a ChatGPT answer and returns as a clean, typed list.

Overview

Entities are not fetched through a dedicated call. They arrive inside the payload of the ChatGPT extract endpoint whenever the answer names something concrete enough to be identified. Think of them as a lightweight, general-purpose companion to shopping cards: instead of pricing or merchant detail, each entry simply tells you what was mentioned and what kind of thing it is.

The array preserves the order in which ChatGPT introduces each item, so index 0 corresponds to the first item referenced in the response text. This lets you reconstruct how prominently a given product or brand featured in the answer.

Entity structure

Every element of the entities array is a small object with two fields:

Response example

A request to the ChatGPT extract endpoint such as:

{
  "prompt": "What are the best sneakers under $100?",
  "model": "CHATGPT",
  "country": "US"
}

returns a payload whose entities array lists each identified item in mention order:

{
  "success": true,
  "result": {
    "text": "Here are a few solid sneaker picks under $100...",
    "entities": [
      {
        "type": "product",
        "name": "adidas Grand Court Lo"
      },
      {
        "type": "product",
        "name": "Reebok Club C 85 Vintage"
      },
      {
        "type": "product",
        "name": "Nike Dunk Low Retro SE"
      }
    ]
  }
}

Notes

Entities populate automatically — no query flag is required. When ChatGPT gives a purely conversational reply that names nothing identifiable, the entities array is simply returned empty. For richer commerce metadata (price, image, seller), pair this data with the shopping cards and inline products sections of the same response. Questions about the payload can be sent to [email protected].