Request and response flow
The ChatGPT scraper handles the rendering, parsing, and delivery of results in your requested format. You provide your prompt, API credentials, and optional parameters to receive structured responses.Making a request
Send a POST request to the API endpoint with your prompt and configuration:Set an appropriate timeout of 120-180 seconds when making requests, as ChatGPT responses may take time to generate depending on complexity.
Authentication
The API uses Bearer token authentication. Include your API key in the Authorization header:Rendering and parsing process
When you submit a request, the ChatGPT scraper:- Handles the rendering - Manages authentication, sessions, and anti-bot systems automatically
- Processes the prompt - Sends your prompt to ChatGPT with any specified parameters
- Collects the response - Captures the complete AI-generated response as it streams
- Parses the data - Extracts structured metadata including shopping cards, search queries, and more
- Delivers results - Returns the data in your requested format (JSON, Markdown, etc.)
The scraper eliminates the need for you to manage authentication, sessions, or anti-bot systems yourself.
Request parameters
You can customize your requests with these parameters:| Parameter | Description | Default |
|---|---|---|
prompt* | The prompt or question to send to ChatGPT (1-10,000 characters) | – |
country | Optional country/region code for localized monitoring (e.g., US, GB, DE) | – |
include.markdown | Include response in Markdown format when set to true | false |
include.rawResponse | Include raw streaming response events for debugging (+2 credits) | false |
include.searchQueries | Include query fan-out ChatGPT used to generate response (+2 credits) | false |
Response structure
The API returns a structured JSON object containing ChatGPT’s response and metadata:Timeout recommendations
For production environments, implement a retry mechanism in case of failures rather than relying solely on timeouts. The cloro system retries automatically on its end to ensure reliable delivery.Output formats
You can retrieve responses in multiple formats:Plain text
Default text format in the
result.text fieldMarkdown
Formatted response when
include.markdown is trueStructured JSON
Complete metadata and parsed data
Raw HTML
Raw response data for advanced debugging