API Reference › AI Mode › Extract Perplexity
Extract Perplexity
Query Perplexity AI with any prompt and receive a clean, structured breakdown of the answer, its cited sources, and any rich cards it surfaces.
POST https://api.cloro.cloud/v1/monitor/perplexity
Overview
This endpoint runs a prompt through Perplexity and parses the reply into machine-readable fields. Beyond the plain answer text, cloro pulls apart the citation trail, media, and any commerce or place cards Perplexity returns, so you can track how a brand, product, or topic is represented without scraping the interface yourself. Provide a country to localize the result, and toggle optional payloads such as raw HTML or markdown through the include object.
Authenticate with a bearer token in the Authorization header and send the body as JSON.
Request parameters
| Field | Type | Description |
|---|---|---|
| prompt | string | The question or instruction to send to Perplexity. Required. |
| country | string | Two-letter country code used to localize the query, e.g. US. |
| include | object | Flags controlling which extra representations are attached to the response. |
| include.html | boolean | When true, a hosted HTML capture of the rendered answer is returned. Defaults to false. |
| include.markdown | boolean | When true, the answer is also returned as markdown. Defaults to false. |
| include.rawResponse | boolean | When true, the unprocessed upstream payload is included. Defaults to false. |
Response fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the extraction completed successfully. |
| result.text | string | The plain-text answer produced by Perplexity. |
| result.markdown | string | Markdown rendering of the answer, present when requested. |
| result.html | string | URL of the hosted HTML capture, present when requested. |
| result.sources | array | Ordered list of references cited in the answer, each with position, url, label, and description. |
| result.citationPills | array | Inline citation chips linking passages to a domain, with citationPillId, url, domain, and position. |
| result.related_queries | array | Follow-up queries suggested alongside the answer. |
| result.videos | array | Video results with title, url, thumbnail, and dimension metadata. |
| result.images | array | Image results with title, source url, and thumbnail details. |
| result.hotels | array | Lodging cards including name, rating, address, coordinates, and pricing. |
| result.places | array | Point-of-interest cards such as restaurants, with rating, address, and coordinates. |
| result.shopping_cards | array | Product cards grouping titles, prices, ratings, and merchant offers. |
Response example
{
"success": true,
"result": {
"text": "Here are several well-reviewed laptops that suit software development...",
"markdown": "Here are several well-reviewed laptops that suit software development...",
"html": "https://storage.cloro.cloud/results/c45a5081-808d-4ed3-9c86-e4baf16c8ab8/page-1.html",
"sources": [
{
"position": 1,
"url": "https://example-reviews.com/dev-laptops",
"label": "Example Reviews",
"description": "Hands-on laptop testing for developers"
},
{
"position": 2,
"url": "https://example-tech.com/best-laptops-2026",
"label": "Best Laptops 2026",
"description": "Annual roundup of top machines"
}
],
"citationPills": [
{
"label": "Developer Laptop Guide — Example Reviews",
"citationPillId": 1,
"url": "https://example-reviews.com/dev-laptops",
"domain": "example-reviews.com",
"description": "Hands-on laptop testing for developers",
"position": 1
}
],
"related_queries": [
"best lightweight laptops for coding",
"laptops with the longest battery life for developers",
"recommended RAM for local machine learning"
],
"videos": [
{
"title": "Top Developer Laptops Compared",
"url": "https://example-video.com/watch?v=devlaptops",
"thumbnail": "https://cdn.example.com/thumbs/devlaptops.jpg",
"medium": "image",
"source": "web",
"image_width": 1920,
"image_height": 1080,
"thumbnail_width": 300,
"thumbnail_height": 200
}
],
"shopping_cards": [
{
"products": [
{
"title": "Example UltraBook 14",
"position": 1,
"url": "https://shop.example.com/ultrabook-14",
"description": "Compact laptop tuned for development workflows",
"price": "$1,199.00",
"rating": 4.6,
"num_reviews": 2140,
"id": "prod_88213",
"offers": [
{
"merchant_name": "Example Store",
"product_name": "Example UltraBook 14",
"url": "https://shop.example.com/ultrabook-14",
"price": "$1,199.00",
"details": "In stock, free delivery",
"available": true
}
]
}
]
}
]
}
}
Notes
- Rich blocks such as
hotels,places,videos, andshopping_cardsonly appear when Perplexity returns them for the given prompt; expect most fields to be empty arrays for a typical text answer. - Hosted
htmlcaptures are served fromstorage.cloro.cloudand are intended for short-term retrieval after extraction. - For anything unclear, reach out to [email protected].