# cloro

## Docs

- [Google AI Mode ads schema](https://cloro.dev/docs/api-reference/endpoint/aimode/ads.md): 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 citation pills schema](https://cloro.dev/docs/api-reference/endpoint/aimode/citation-pills.md): 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 inline products schema](https://cloro.dev/docs/api-reference/endpoint/aimode/inline-products.md): Schema for individual product references embedded inline in the Google AI Mode response text, including titles, prices, merchants, and offer links.
- [Google AI Mode map schema](https://cloro.dev/docs/api-reference/endpoint/aimode/map.md): Schema for GPS-enriched location data returned by the Google AI Mode endpoint when map-aware results are surfaced, including coordinates, names, and addresses.
- [Google AI Mode places schema](https://cloro.dev/docs/api-reference/endpoint/aimode/places.md): 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](https://cloro.dev/docs/api-reference/endpoint/aimode/shopping-cards.md): 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 sources schema](https://cloro.dev/docs/api-reference/endpoint/aimode/sources.md): 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 videos schema](https://cloro.dev/docs/api-reference/endpoint/aimode/videos.md): Schema for inline video cards embedded within the Google AI Mode response, including titles, thumbnails, durations, channels, and source links.
- [ChatGPT sponsored ads schema](https://cloro.dev/docs/api-reference/endpoint/chatgpt/ads.md): Schema for sponsored ad blocks extracted from ChatGPT responses, including advertiser branding, product carousel cards, pricing, and offer metadata.
- [ChatGPT citation pills schema](https://cloro.dev/docs/api-reference/endpoint/chatgpt/citation-pills.md): 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 entities schema](https://cloro.dev/docs/api-reference/endpoint/chatgpt/entities.md): Schema for structured entity data extracted from ChatGPT responses, including products, brands, organizations, people, and concepts with descriptions.
- [ChatGPT inline products schema](https://cloro.dev/docs/api-reference/endpoint/chatgpt/inline-products.md): Individual product references with detailed rationale, themed reviews, and rendering hints for inline display in ChatGPT responses.
- [ChatGPT map entries schema](https://cloro.dev/docs/api-reference/endpoint/chatgpt/map.md): Business and place information extracted from ChatGPT responses, including ratings, reviews, contact details, and location data from Yelp and Google.
- [ChatGPT shopping cards schema](https://cloro.dev/docs/api-reference/endpoint/chatgpt/shopping-cards.md): Schema for structured shopping cards extracted from ChatGPT responses, including product titles, pricing, ratings, merchant offers, and commercial details.
- [ChatGPT sources schema](https://cloro.dev/docs/api-reference/endpoint/chatgpt/sources.md): Schema for source citations extracted from ChatGPT responses, including URLs, titles, snippets, publication dates, and footnote indicators.
- [Microsoft Copilot citation pills schema](https://cloro.dev/docs/api-reference/endpoint/copilot/citation-pills.md): 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 map entries schema](https://cloro.dev/docs/api-reference/endpoint/copilot/map-entries.md): Schema for business and place entries returned by the Microsoft Copilot endpoint, including names, ratings, reviews, photos, contact details, and addresses.
- [Microsoft Copilot shopping cards schema](https://cloro.dev/docs/api-reference/endpoint/copilot/shopping-cards.md): Schema for shopping product cards returned by the Microsoft Copilot endpoint, including product titles, pricing, ratings, merchant offers, and image URLs.
- [Microsoft Copilot sources schema](https://cloro.dev/docs/api-reference/endpoint/copilot/sources.md): Schema for source citations returned by the Microsoft Copilot endpoint, listing URLs, titles, snippets, and publishers referenced in the generated answer.
- [List of countries](https://cloro.dev/docs/api-reference/endpoint/countries.md): 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.
- [Create async task](https://cloro.dev/docs/api-reference/endpoint/create-async-task.md): Submit an asynchronous task for background processing. Returns a task ID that you can use to poll for results or receive via webhook.
- [Create batch tasks](https://cloro.dev/docs/api-reference/endpoint/create-batch-tasks.md): 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.
- [Google Gemini citation pills schema](https://cloro.dev/docs/api-reference/endpoint/gemini/citation-pills.md): 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 sources schema](https://cloro.dev/docs/api-reference/endpoint/gemini/sources.md): Schema for source citations returned by the Google Gemini endpoint, including URLs, titles, snippets, and contextual descriptions for each reference.
- [Get async status](https://cloro.dev/docs/api-reference/endpoint/get-async-status.md): Get organization-wide async queue metrics including queued and processing task counts, and concurrency usage.
- [Get task status](https://cloro.dev/docs/api-reference/endpoint/get-task-status.md): Poll the status and result of an asynchronous task by ID. Returns the task state and, once complete, the full structured result payload.
- [Google News articles schema](https://cloro.dev/docs/api-reference/endpoint/google-news/news-articles.md): Schema for structured news articles returned by the Google News endpoint, including titles, links, snippets, sources, publication dates, and thumbnails.
- [Google AI Overview schema](https://cloro.dev/docs/api-reference/endpoint/google/ai-overview.md): 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](https://cloro.dev/docs/api-reference/endpoint/google/knowledge-graph.md): Schema for the Knowledge Graph panel returned by the Google Search endpoint: entity details, attributes, ratings, profiles, and panel-specific fields.
- [Google Local Pack schema](https://cloro.dev/docs/api-reference/endpoint/google/local-pack.md): Schema for Google's local pack (map-backed 3-pack) returned by the Google Search endpoint, including ratings, category, address, phone, and hours.
- [Google organic search results schema](https://cloro.dev/docs/api-reference/endpoint/google/organic-results.md): Schema for organic search results returned by the Google Search endpoint, including page title, URL, snippet, position, sitelinks, and rich enrichments.
- [Google People Also Ask schema](https://cloro.dev/docs/api-reference/endpoint/google/people-also-ask.md): 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](https://cloro.dev/docs/api-reference/endpoint/google/people-are-saying.md): 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 related searches schema](https://cloro.dev/docs/api-reference/endpoint/google/related-searches.md): 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 Search shopping cards schema](https://cloro.dev/docs/api-reference/endpoint/google/shopping-cards.md): Shopping product information returned by the Google Search endpoint when 'Popular products' or 'More products' panels appear on the SERP.
- [Google Search sponsored ads schema](https://cloro.dev/docs/api-reference/endpoint/google/sponsored-ads.md): 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.
- [Grok sources schema](https://cloro.dev/docs/api-reference/endpoint/grok/sources.md): Schema for source citations returned by the Grok endpoint, enriched with preview text, creator details, site information, image URLs, and publication dates.
- [Extract Google AI Mode](https://cloro.dev/docs/api-reference/endpoint/monitor-aimode.md): Extract structured data from AI Mode about your brand, products, or any topic across various regions
- [Extract ChatGPT](https://cloro.dev/docs/api-reference/endpoint/monitor-chatgpt.md): Extract structured data from ChatGPT — answer text, cited sources, shopping cards, brand entities, and ads — for any prompt across supported regions
- [Extract Microsoft Copilot](https://cloro.dev/docs/api-reference/endpoint/monitor-copilot.md): Extract structured data from Microsoft Copilot about your brand, products, or any topic across various regions
- [Extract Google Gemini](https://cloro.dev/docs/api-reference/endpoint/monitor-gemini.md): Extract structured data from Google Gemini — generated answer text and cited sources for any prompt, with Markdown and HTML export formats
- [Extract Google Search](https://cloro.dev/docs/api-reference/endpoint/monitor-google.md): Extract structured data from Google Search including organic results, People Also Ask, related searches, and optional AI Overview
- [Extract Google News](https://cloro.dev/docs/api-reference/endpoint/monitor-google-news.md): Extract structured news articles from Google News including titles, links, snippets, sources, dates, and thumbnails
- [Extract Grok](https://cloro.dev/docs/api-reference/endpoint/monitor-grok.md): Extract structured data from Grok — answer text and cited sources, including X/Twitter references — for any prompt across supported regions
- [Extract Perplexity](https://cloro.dev/docs/api-reference/endpoint/monitor-perplexity.md): Extract structured data from Perplexity AI about your brand, products, or any topic across various regions
- [Perplexity citation pills schema](https://cloro.dev/docs/api-reference/endpoint/perplexity/citation-pills.md): 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 media results schema](https://cloro.dev/docs/api-reference/endpoint/perplexity/media.md): Schema for videos and images returned by the Perplexity endpoint when media is relevant to the query, including thumbnails, source URLs, and captions.
- [Perplexity shopping cards schema](https://cloro.dev/docs/api-reference/endpoint/perplexity/shopping-cards.md): Schema for shopping product cards returned by the Perplexity endpoint when shopping intent is detected, including titles, prices, ratings, and merchant links.
- [Perplexity sources schema](https://cloro.dev/docs/api-reference/endpoint/perplexity/sources.md): Schema for source citations returned by the Perplexity endpoint, listing URLs, titles, snippets, and publishers referenced throughout the generated answer.
- [Perplexity travel and places schema](https://cloro.dev/docs/api-reference/endpoint/perplexity/travel-and-places.md): Schema for hotel listings and place cards returned by the Perplexity endpoint when travel intent is detected, including pricing, ratings, and amenities.
- [List of states](https://cloro.dev/docs/api-reference/endpoint/states.md): Returns a list of US states supported for state-level geo-targeting. Only US is currently supported — other country values return an empty array.
- [API reference](https://cloro.dev/docs/api-reference/introduction.md): Reference for the cloro API: base URL, authentication, response envelope, and monitoring endpoints for ChatGPT, Gemini, Copilot, Perplexity, and Google.
- [Changelog](https://cloro.dev/docs/changelog.md): Stay up to date with the latest cloro API product updates, new features, enhancements, bug fixes, and announcements about our monitoring endpoints.
- [Authentication](https://cloro.dev/docs/guides/authentication.md): Learn how to authenticate with the cloro API using Bearer tokens, manage API keys securely, and handle authentication errors in your requests.
- [Billing & credits](https://cloro.dev/docs/guides/billing.md): Subscription plans, credit allocation and expiration, payment cycles, standard vs. enterprise plans, overage policies, and account management for the cloro API.
- [Rate & concurrency limits](https://cloro.dev/docs/guides/concurrency.md): Understand cloro's rate and concurrency limits, read the response headers, and process many requests efficiently with async patterns and concurrent workers.
- [Error handling](https://cloro.dev/docs/guides/error-handling.md): Understanding API errors, HTTP status codes, error response formats, retry logic, and troubleshooting strategies for all cloro monitoring endpoints.
- [Making requests](https://cloro.dev/docs/guides/making-requests.md): Compare the two cloro request modes — synchronous and asynchronous — including credit cost, latency, concurrency limits, and guidance on which mode to use.
- [Asynchronous requests](https://cloro.dev/docs/guides/making-requests/async.md): Submit async tasks to the cloro API: two-step submit-and-fetch flow, webhooks vs polling, task states, prioritization, queue limits, and concurrency.
- [Synchronous requests](https://cloro.dev/docs/guides/making-requests/sync.md): Make synchronous requests to the cloro API: request structure, common parameters, response shape, optional formats, and code examples.
- [Output formats](https://cloro.dev/docs/guides/output-formats.md): 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.
- [Providers](https://cloro.dev/docs/guides/providers.md): Compare cloro provider support across ChatGPT, Gemini, Copilot, Perplexity, Grok, Google AI Mode, and Google Search, including features and credit costs.
- [Webhooks](https://cloro.dev/docs/guides/webhooks.md): Receive async task results via webhooks: payload shape, retry behavior, HMAC signature verification in Node.js, Python, and Go, and troubleshooting tips.
- [Welcome to cloro](https://cloro.dev/docs/index.md): Extract structured data from ChatGPT, Perplexity, Microsoft Copilot, Google AI Mode, Google Search with AI Overview and other AI models
- [LangChain](https://cloro.dev/docs/integrations/langchain.md): Use the langchain-cloro Python package to give LangChain agents ready-made tools for Google Search, ChatGPT, Gemini, Perplexity, and Copilot.
- [n8n integration — query AI engines from workflows](https://cloro.dev/docs/integrations/n8n.md): 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.
- [OpenClaw](https://cloro.dev/docs/integrations/openclaw.md): 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.
- [Python SDK](https://cloro.dev/docs/integrations/python.md): Use the cloro Python SDK (pip install cloro) as one client for Google Search, ChatGPT, Gemini, Perplexity, Copilot, Grok, AI Mode, and Google News — structured JSON back, no proxies or selectors.
- [TypeScript SDK](https://cloro.dev/docs/integrations/typescript.md): Use the cloro TypeScript/Node SDK (npm install @cloro-dev/cloro) as one typed client for Google Search, ChatGPT, Gemini, Perplexity, Copilot, Grok, AI Mode, and Google News — structured JSON back, no proxies or selectors.
- [Zapier integration — connect cloro to 8,000+ apps](https://cloro.dev/docs/integrations/zapier.md): 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.
- [Quickstart](https://cloro.dev/docs/introduction/quickstart.md): 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.

## OpenAPI Specs

- [openapi](https://cloro.dev/docs/api-reference/openapi.json)