ChatGPT
ChatGPT answers: the answer a signed-out visitor gets for a prompt with web search on, the citations behind it and the product cards it shows.
Call these actions with your String API key; see Authentication. Every call answers with the envelope described in Responses & errors, whose data holds the rows below.
- Site:
chatgpt - Version:
1.1.0 - Reads from:
chatgpt.com
| Action | Description | Listed price |
|---|---|---|
answer | Ask ChatGPT one question as a signed-out visitor with web search on and get the answer it writes: markdown text with inline citation markers, the sources it cites, the product cards it shows with their prices, merchants and links, whether a web search ran and how many sites it searched, the conversation id, and the persona and web build the answer was served under. | Billed per request at your plan's rates |
answer
Ask ChatGPT one question as a signed-out visitor with web search on and get the answer it writes: markdown text with inline citation markers, the sources it cites, the product cards it shows with their prices, merchants and links, whether a web search ran and how many sites it searched, the conversation id, and the persona and web build the answer was served under.
POST https://request.usestring.ai/v1/integrations/chatgpt/answerInput
Unknown fields are rejected.
| Field | Type | Description |
|---|---|---|
query | string | Required. The question to ask ChatGPT. At least 1 character. Matches \S. |
Output
data is an array of rows, one per result. Each row has:
| Field | Type | Description |
|---|---|---|
query | string | — |
answerMarkdown | string | The answer's markdown text, with the inline citation markers kept verbatim. |
conversationId | string | null | The conversation the answer belongs to. |
webSearchRan | boolean | Whether a web search ran for the answer. |
searchedSiteCount | integer | null | How many sites the answer reports searching; null when the stream does not say. |
persona | string | The client persona the answer was served under, such as chatgpt-noauth. |
clientBuild | string | The chatgpt.com web build that produced the answer. |
citations | object[] | The sources the answer shows, in the order it shows them: the ones its inline citation markers point at (Cite) and the links on the cards it shows (Link) |
citations[].position | integer | Position in the answer's source list, from 1. |
citations[].kind | string | Cite for a source an inline citation marker points at, Link for a link on a card the answer shows, such as a product's website. |
citations[].refId | string | null | The id an inline citation marker in answerMarkdown names this source by, such as turn0search3; null for a Link. |
citations[].url | string | — |
citations[].title | string | null | — |
citations[].sourceLabel | string | null | The site name shown for the source. |
citations[].snippet | string | null | The passage the source contributed, when the stream carries one. |
citations[].domain | string | The source URL's host, without a leading www. |
citations[].publishedTimestamp | integer | null | The source's publication time in unix seconds, when the stream carries it. |
products | object[] | The product cards the answer shows, in the order it shows them; empty when the answer shows none, such as an answer that names products only in its text. |
products[].position | integer | Position in the answer's product list, from 1. |
products[].refId | string | null | The id answerMarkdown names this product by, such as turn836743product9. |
products[].productId | string | null | ChatGPT's id for the product; for some merchants it is also the merchant's item number. |
products[].title | string | — |
products[].price | string | null | The price as the card shows it, with its currency symbol, such as $31.99. |
products[].originalPrice | string | null | The price before a discount, when the card shows one. |
products[].merchant | string | null | The merchant shown on the card. |
products[].brand | string | null | — |
products[].url | string | null | The product's page at the merchant. |
products[].rating | number | null | The average customer rating, out of 5. |
products[].reviewCount | integer | null | How many customer reviews the rating covers. |
products[].description | string | null | — |
products[].imageUrls | string[] | The card's product images. |
products[].offers | object[] | Each merchant's offer for the product, in the order the card lists them. |
products[].offers[].merchant | string | null | — |
products[].offers[].seller | string | null | The seller named on the offer. |
products[].offers[].url | string | null | — |
products[].offers[].price | string | null | The price as the offer shows it, with its currency symbol. |
products[].offers[].originalPrice | string | null | The price before a discount, when the offer shows one. |
products[].offers[].details | string | null | The offer's stock or delivery line, such as In stock. |
products[].offers[].available | boolean | null | — |
products[].offers[].tag | string | null | The label on the offer, such as Best price. |
Example
curl https://request.usestring.ai/v1/integrations/chatgpt/answer \
-H "Authorization: Bearer $STRING_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "What is the tallest mountain in Africa?"
}'data starts with these rows:
[
{
"query": "What is the tallest mountain in Africa?",
"answerMarkdown": "The tallest mountain in Africa is **Mount Kilimanjaro**, located in northeastern Tanzania.\n\nimage_group{\"query\":[\"Mount Kilimanjaro snow capped summit Tanzania Africa\"],\"aspect_ratio\":\"16:9\",\"layout\":\"carousel\",\"num_per_query\":1}\n\n- **Height\\:** 5,895 meters (19,341 feet) above sea level.\n- **Location\\:** Tanzania, near the border with Kenya.\n- **Type\\:** Dormant volcanic mountain.\n- **Highest point\\:** Uhuru Peak.\n\nMount Kilimanjaro is also the **highest free-standing mountain in the world**, meaning it does not form part of a larger mountain range.\n\nLearn more: urlUNESCO’s guide to Kilimanjaro National Parkhttps://whc.unesco.org/en/list/403\\.",
"conversationId": "6ad8bcc3-7a74-83ea-8218-cdbe04fab0ee",
"webSearchRan": true,
"searchedSiteCount": 12,
"persona": "chatgpt-noauth",
"clientBuild": "prod-59702a84751bcc53e7cf3fc6e8f5022acb883535",
"citations": [
{
"position": 1,
"kind": "Link",
"refId": null,
"url": "https://whc.unesco.org/en/list/403?utm_source=chatgpt.com",
"title": "whc.unesco.org",
"sourceLabel": "whc.unesco.org",
"snippet": null,
"domain": "whc.unesco.org",
"publishedTimestamp": null
}
],
"products": []
}
]Requests and billing
- Requests: 5 Web Access requests per call.
- Billing:
passthrough. Each request the action makes bills at its own rate on your plan; there is no separate charge for the action. See Pricing.
Reddit posts with their full comment trees, post and comment search with subreddit, sort and time filters, a subreddit's hot, new, top, rising or controversial listing, one account's profile with its posts and comments, and Reddit Reviews product pages: Reddit's AI summary of what people say about a product, its sentiment split, takeaways and source comments.
SHEIN
SHEIN (shein.com) product details (title, prices, images, colors, sizes with stock, category and rating) and keyword search.