Skip to main content

Overview

The ChatGPT Scraper API returns a structured JSON object containing ChatGPT’s response and metadata. The number of items and fields may vary depending on the submitted prompt and whether shopping cards are available in the response.

Main Response Fields

string
Status of the monitoring request (e.g., success).
string
The ChatGPT model used to generate the response (e.g., gpt-5-mini).
string
The complete ChatGPT response as plain text.
string
The response formatted in Markdown. Only included when include.markdown is set to true in the request.
array
Array of shopping/product cards extracted from the response. Automatically included when available at no additional cost.See Shopping Cards Schema for detailed structure.
array
Query fan-out ChatGPT used to generate the response. Only included when include.searchQueries is set to true in the request (+2 credits).This provides insight into how ChatGPT interprets and breaks down your prompt internally.
array
Array of ChatGPT’s streamed response events. Only included when include.rawResponse is set to true in the request (+2 credits).Useful for advanced debugging and understanding response generation timing.

Example Response

Response Formats

The API supports multiple output formats:

Plain Text

Always included in result.text. The complete ChatGPT response as plain text.

Markdown

Optionally included in result.markdown when include.markdown is set to true. The response formatted in Markdown for easier integration with AI tools and documentation workflows.

Shopping Cards

Automatically extracted when ChatGPT returns product or commercial information. No additional parameters required.

Optional Fields

Some fields are only included when specific request parameters are enabled:

Next Steps

Shopping Cards Schema

Detailed shopping card structure

Monitor ChatGPT

Back to endpoint documentation