ChatGPT entities schema - cloro

ChatGPT

ChatGPT entities schema

Schema for structured entity data extracted from ChatGPT responses, including products, brands, organizations, people, and concepts with descriptions.

This section documents the

entities

data returned by the

ChatGPT endpoint

: structured objects for the specific items, products, brands, or concepts ChatGPT identifies in its answer — like shopping cards but more general — part of the ChatGPT response so no separate API call is needed. Entities appear in the order ChatGPT references them; array index

0

is the first entity mentioned. For use cases, pricing context, and copy-paste examples, see the

ChatGPT brand mentions API

page on the product site.

Navigate to header: Example request Example request

Entities are returned by default when ChatGPT mentions identifiable items; no flag is required.

{

"prompt"

:

"What are the best sneakers under $100?"

,

"country"

:

"US"

}

Navigate to header: Entity structure Entity structure

Field Type Description
type string Entity type identifier (e.g., “product”, “software”)
name string Entity name or title
product object The product listing that ChatGPT attached to the entity: price, URL and merchant offers. Same structure as a shopping card product, without position . Only with include.shopping: true , a paid add-on . The listing of a gpt-6 product card is in inlineProducts instead

ChatGPT does not attach a listing to every product that it names, so most entities have no

product

. Two entities have the same

name

when ChatGPT attaches two listings to one product name.

Some answers show a product with a price and a merchant but no full listing. Its

product

then has only

title

,

price

,

merchants

,

rating

and

num_reviews

, with no

id

and no

offers

.

Navigate to header: Response example Response example

{

"success"

:

true

,

"result"

: {

"text"

:

"Here are sneaker options under $100..."

,

"entities"

: [

{

"type"

:

"product"

,

"name"

:

"adidas Grand Court Lo"

,

"product"

: {

"id"

:

"23920641"

,

"title"

:

"adidas Grand Court Lo Sneaker"

,

"url"

:

"https://www.nordstrom.com/s/adidas-grand-court-lo/7654321?utm\_source=chatgpt.com"

,

"price"

:

"$75.00"

,

"merchants"

:

"Nordstrom"

,

"cite"

:

"turn0product4"

,

"offers"

: [

{

"merchant_name"

:

"Nordstrom"

,

"price"

:

"$75.00"

,

"details"

:

"In stock"

,

"available"

:

true

}

]

}

},

{

"type"

:

"product"

,

"name"

:

"Reebok Club C 85 Vintage"

},

{

"type"

:

"product"

,

"name"

:

"Nike Dunk Low Retro SE"

}

]

}

}

Was this page helpful?

Ask a question...

ChatGPT endpoint

ChatGPT brand mentions API

shopping card

paid add-on

inlineProducts

Navigate to header: Example request

Navigate to header: Entity structure

Navigate to header: Response example