Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cloro.dev/llms.txt

Use this file to discover all available pages before exploring further.

This section documents the entities data returned by the ChatGPT endpoint. Entities are part of the ChatGPT response, so no separate API call is needed.

​
Example request

Entities are returned by default when ChatGPT mentions identifiable items. No flag is required. 
{
  "prompt": "What are the best sneakers under $100?",
  "model": "CHATGPT",
  "country": "US"
}
This produces a response containing the entities array documented below.

​
Overview

Entities are structured data objects extracted from ChatGPT responses when specific items, products, or concepts are identified. They provide information about individual items mentioned in the response, similar to shopping cards but more general.

​
Entity structure

Each entity contains:
FieldTypeDescription
typestringEntity type identifier (e.g., “product”, “software”)
namestringEntity name or title

​
Example usage

{
  "prompt": "What are the best sneakers under $100?",
  "model": "CHATGPT",
  "country": "US"
}
Response with entities: 
{
  "success": true,
  "result": {
    "text": "Here are sneaker options 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"
      }
    ]
  }
}