Skip to main content

Endpoint

Request Parameters

string
required
The prompt or question to send to ChatGPT. Must be between 1 and 10,000 characters.
string
Optional country/region code for localized monitoring (e.g., US, GB, DE).
boolean
default:"false"
Include response in Markdown format when set to true. No additional credits.
boolean
default:"false"
Include raw streaming response events for debugging. Adds +2 credits to the request cost.
boolean
default:"false"
Include query fan-out ChatGPT used to generate response. Adds +2 credits to the request cost.

Request Examples

Response

Timeout Recommendations

Set an appropriate timeout (e.g., 120-180 seconds) when making requests, as ChatGPT responses may take time to generate depending on complexity.
We recommend:
  • No timeout limit: Our system handles retries automatically
  • If you must set a timeout: Use 120-180 seconds minimum
  • Implement retry logic: For handling temporary failures

Shopping Cards

One of the unique features is automatic extraction of shopping cards when ChatGPT returns product or commercial information. No additional parameters are required - shopping cards are included by default when available in the response.

Shopping Card Features

  • Comprehensive product data: Product titles, prices, ratings, reviews, images, and merchant information
  • Multiple offers: Compare prices across different merchants for the same product
  • Rating citations: Track the source of product ratings and supporting websites
  • Promotional tags: Identify special offers like “Best price” or promotional deals
  • Stock information: Check product availability and delivery details

Advanced Features

Query Fan-Out Insights

When you set include.searchQueries to true (+2 credits), the API reveals the actual query fan-out ChatGPT used internally to generate its response. This provides valuable insight into:
  • How ChatGPT interprets and breaks down your prompt
  • What specific searches it performs to gather information
  • How to optimize your prompts for better results

Raw Response Access

Enable include.rawResponse (+2 credits) to access the complete streaming response payload. This is useful for:
  • Advanced debugging and analysis
  • Understanding response generation timing
  • Accessing low-level response metadata

Next Steps

Response Structure

Learn about the response fields

Shopping Cards Schema

Explore shopping card structure