# cloro

- **Welcome to cloro**: Extract structured data from ChatGPT, Perplexity, Microsoft Copilot, Google AI Mode, Google Search with AI Overview and other AI models

- **Quickstart: make your first cloro API request**: Get started with the cloro API in minutes. Learn how to get your API key, make your first monitoring request, and understand the response structure.

- **Authentication**: Learn how to authenticate with the cloro API using Bearer tokens, manage API keys securely, and handle authentication errors in your requests.

- **Making requests**: Compare the two cloro request modes — synchronous and asynchronous — including credit cost, latency, concurrency limits, and guidance on which mode to use.

- **Synchronous requests**: Make synchronous requests to the cloro API: request structure, common parameters, response shape, optional formats, and code examples.

- **Asynchronous requests**: Submit async tasks to cloro: submit-and-fetch flow, webhooks vs polling, task states, priority, queue limits, and clearing queued jobs.

- **Webhooks**: Receive async task results via webhooks: payload shape, retry behavior, HMAC signature verification in Node.js, Python, and Go, and troubleshooting tips.

- **Error handling**: Understanding API errors, HTTP status codes, error response formats, retry logic, and troubleshooting strategies for all cloro monitoring endpoints.

- **Versioning and deprecation**: How the cloro API is versioned, which changes ship without warning, how a deprecation is announced, and what the Deprecation and Sunset headers tell you.

- **Rate & concurrency limits**: Understand cloro's rate and concurrency limits, read the response headers, and process many requests efficiently with async patterns and concurrent workers.

- **Supported AI providers, features, and credit pricing**: Compare cloro provider support across ChatGPT, Gemini, Copilot, Perplexity, Grok, Google AI Mode, and Google Search, including features and credit costs.

- **Billing & credits**: cloro subscription plans, monthly credit allocation and expiration, billing cycles, invoices, enterprise contracts, and how to manage your subscription.

- **Account & organizations**: How cloro user accounts and organizations relate, how to manage team members, and how to delete either from the dashboard and what that removes.

- **Output formats**: Learn how to render proof-of-page HTML, request optional text and markdown outputs, and handle inline objects in cloro API responses for LLM analysis.

- **MCP server: give any agent cloro's monitoring tools**: Connect Claude, Cursor, or any MCP client to cloro's hosted MCP server and query ChatGPT, Perplexity, Gemini, Copilot, and Google Search as agent tools.

- **Python SDK**: Official cloro Python SDK reference: install, authenticate, and call Google Search, ChatGPT, Gemini, Perplexity, Copilot, Grok, and AI Mode.

- **TypeScript SDK**: Official cloro TypeScript and Node SDK reference: install, authenticate, and call Google Search, ChatGPT, Gemini, Perplexity, Copilot, Grok, and AI Mode.

- **n8n integration — query AI engines from workflows**: Install the n8n-nodes-cloro community node and query ChatGPT, Perplexity, Gemini, Copilot, Google AI Mode, Google Search, and Google News from any n8n workflow.

- **Zapier integration — connect cloro to 8,000+ apps**: Connect cloro to 8,000+ apps with Zapier — trigger AI-engine and Google Search checks from any Zap and send parsed results to Sheets, Slack, or your CRM.

- **LangChain**: Use the langchain-cloro Python package to give LangChain agents ready-made tools for Google Search, ChatGPT, Gemini, Perplexity, and Copilot.

- **OpenClaw**: Install the cloro plugin for OpenClaw and give your agent tools to monitor ChatGPT, Perplexity, Gemini, Copilot, Google AI Mode, Google Search, and Google News.

- **API reference**: Reference for the cloro API: base URL, authentication, response envelope, and monitoring endpoints for ChatGPT, Gemini, Copilot, Perplexity, and Google.

- **Extract ChatGPT**: Extract structured data from ChatGPT — answer text, cited sources, shopping cards, brand entities, and ads — for any prompt across supported regions.

- **ChatGPT sources schema**: Schema for source citations extracted from ChatGPT responses, including URLs, titles, snippets, publication dates, and footnote indicators.

- **ChatGPT shopping cards schema**: Schema for structured shopping cards extracted from ChatGPT responses, including product titles, pricing, ratings, merchant offers, and commercial details.

- **ChatGPT inline products schema**: Individual product references with detailed rationale, themed reviews, and rendering hints for inline display in ChatGPT responses.

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

- **ChatGPT map entries schema**: Business and place information extracted from ChatGPT responses, including ratings, reviews, contact details, and location data from Yelp and Google.

- **ChatGPT citation pills schema**: Schema for inline citation pills returned by the ChatGPT endpoint, with each cited source attached to the visible pill chip it appears on in the answer.

- **ChatGPT sponsored ads schema**: Schema for sponsored ad blocks extracted from ChatGPT responses, including advertiser branding, product carousel cards, pricing, and offer metadata.

- **Extract Google Search**: Extract structured data from Google Search including organic results, People Also Ask, related searches, and optional AI Overview.

- **Resolve a Google redirect link**: Read Google's /goto redirect beside the destination with redirectLink, and resolve a redirect to its destination URL.

- **Google organic search results schema**: Schema for organic search results returned by the Google Search endpoint, including page title, URL, snippet, position, sitelinks, and rich enrichments.

- **Google Search sponsored ads schema**: Schema for sponsored ad results returned by the Google Search endpoint, including text ads and shopping-style cards from top-of-page and side carousels.

- **Google Search shopping cards schema**: Shopping product information returned by the Google Search endpoint when 'Popular products' or 'More products' panels appear on the SERP.

- **Google Search product results schema**: Schema for merchant offers parsed from the Google Search right-rail product panel: direct URLs, prices, installments, stock, and delivery badges.

- **Google People Also Ask schema**: Schema for People Also Ask questions returned by the Google Search endpoint, including expanded answers, source links, and optional AI Overview hydration.

- **Google People Are Saying schema**: Schema for cards from Google's 'What people are saying' SERP module returned by the Google Search endpoint, including source URLs, snippets, and themes.

- **Google Local Pack schema**: Schema for Google's local pack (map-backed 3-pack) returned by the Google Search endpoint, including ratings, category, address, phone, and hours.

- **Google related searches schema**: Schema for related search suggestions returned by the Google Search endpoint, including query text and links that surface related user intent on the SERP.

- **Google AI Overview schema**: AI Overview data returned by the Google Search endpoint, including text, markdown, sources, citation pills, related links, videos, and sponsored ads.

- **Google Knowledge Graph schema**: Schema for the Knowledge Graph panel returned by the Google Search endpoint: entity details, attributes, ratings, profiles, and panel-specific fields.

- **Extract Perplexity**: Extract structured data from Perplexity AI about your brand, products, or any topic across various regions.

- **Perplexity sources schema**: Schema for source citations returned by the Perplexity endpoint, listing URLs, titles, snippets, and publishers referenced throughout the generated answer.

- **Perplexity citation pills schema**: Schema for inline citation pills returned by the Perplexity endpoint, with each cited source attached to the visible pill chip it appears on in the answer.

- **Perplexity shopping cards schema**: Schema for shopping product cards returned by the Perplexity endpoint when shopping intent is detected, including titles, prices, ratings, and merchant links.

- **Perplexity media results schema**: Schema for videos and images returned by the Perplexity endpoint when media is relevant to the query, including thumbnails, source URLs, and captions.

- **Perplexity travel and places schema**: Schema for hotel listings and place cards returned by the Perplexity endpoint when travel intent is detected, including pricing, ratings, and amenities.

- **Extract Microsoft Copilot**: Extract structured data from Microsoft Copilot about your brand, products, or any topic across various regions.

- **Microsoft Copilot sources schema**: Schema for source citations returned by the Microsoft Copilot endpoint, listing URLs, titles, snippets, and publishers referenced in the generated answer.

- **Microsoft Copilot citation pills schema**: Schema for inline citation pills returned by the Microsoft Copilot endpoint, with each cited source attached to the visible pill chip it appears on.

- **Microsoft Copilot shopping cards schema**: Schema for shopping product cards returned by the Microsoft Copilot endpoint, including product titles, pricing, ratings, merchant offers, and image URLs.

- **Microsoft Copilot map entries schema**: Schema for business and place entries returned by the Microsoft Copilot endpoint, including names, ratings, reviews, photos, contact details, and addresses.

- **Extract Google AI Mode**: Extract structured data from AI Mode about your brand, products, or any topic across various regions.

- **Google AI Mode sources schema**: Schema for source citations returned by the Google AI Mode endpoint, listing URLs, titles, snippets, and publishers referenced in the generated answer.

- **Google AI Mode citation pills schema**: Schema for inline citation pills returned by the Google AI Mode endpoint, with each cited source attached to the visible pill chip it appears on.

- **Google AI Mode places schema**: Schema for inline place cards returned by the Google AI Mode endpoint when location intent is detected, including business names, ratings, and addresses.

- **Google AI Mode shopping cards schema**: Schema for shopping product cards returned by the Google AI Mode endpoint when shopping intent is detected, with pricing, ratings, offers, and reviews.

- **Google AI Mode product results schema**: Schema for expanded merchant offers behind each Google AI Mode product cluster: direct URLs, prices, installments, stock, and delivery badges.

- **Google AI Mode ads schema**: Schema for sponsored ad blocks returned by the Google AI Mode endpoint, including merchant branding, product carousel cards, pricing, and ad metadata.

- **Google AI Mode inline products schema**: Schema for individual product references embedded inline in the Google AI Mode response text, including titles, prices, merchants, and offer links.

- **Google AI Mode videos schema**: Schema for inline video cards embedded within the Google AI Mode response, including titles, thumbnails, durations, channels, and source links.

- **Google AI Mode map schema**: Schema for GPS-enriched location data returned by the Google AI Mode endpoint when map-aware results are surfaced, including coordinates, names, and addresses.

- **Extract Grok**: Extract structured data from Grok — answer text and cited sources, including X/Twitter references — for any prompt across supported regions.

- **Grok sources schema**: Schema for source citations returned by the Grok endpoint, enriched with preview text, creator details, site information, image URLs, and publication dates.

- **Extract Google Gemini**: Extract structured data from Google Gemini — generated answer text and cited sources for any prompt, with Markdown and HTML export formats.

- **Google Gemini sources schema**: Schema for source citations returned by the Google Gemini endpoint, including URLs, titles, snippets, and contextual descriptions for each reference.

- **Google Gemini citation pills schema**: Inline citation pills returned by the Gemini endpoint, with each cited source carried as a self-contained entry alongside the visible pill chip it came from.

- **Google Gemini places schema**: Schema for place cards returned by the Google Gemini endpoint when a lodging or local carousel appears, with names, ratings, prices, and links.

- **Extract Google News**: Extract structured news articles from Google News including titles, links, snippets, sources, dates, and thumbnails.

- **Google News articles schema**: Schema for structured news articles returned by the Google News endpoint, including titles, links, snippets, sources, publication dates, and thumbnails.

- **List of countries**: Returns a list of all supported ISO 3166-1 alpha-2 country codes. Can be filtered by model to get countries available for specific AI providers.

- **List of states**: Returns a list of US states supported for state-level geo-targeting. Only US is currently supported — other country values return an empty array.

- **Get credit balance**: Read your organization's credit balance and billing cycle programmatically, so async-only workloads can alert or pause before the balance runs out.

- **Create async task**: Submit an asynchronous task for background processing. Returns a task ID that you can use to poll for results or receive via webhook.

- **Get task status**: Poll the status and result of an asynchronous task by ID. Returns the task state and, once complete, the full structured result payload.

- **Create batch tasks**: Submit up to 500 async tasks in one request. Each task is validated independently, so one invalid task does not block the rest. Returns per-task results.

- **Get async status**: Get organization-wide async queue metrics including queued and processing task counts, and concurrency usage.

- **Clear queue**: Delete every QUEUED async task for your organization in one call. Tasks already processing keep running, and completed or failed history stays in place.

- **Changelog**: Stay up to date with the latest cloro API product updates, new features, enhancements, bug fixes, and announcements about our monitoring endpoints.
