Skip to main content
POST
/
v1
/
monitor
/
perplexity
Monitor Perplexity Responses
curl --request POST \
  --url https://api.cloro.dev/v1/monitor/perplexity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "What are the best laptops for programming?",
  "country": "US",
  "include": {
    "html": false,
    "markdown": false,
    "rawResponse": false
  }
}
'
{
  "success": true,
  "result": {
    "text": "Based on current sources and information, here are the best laptops for programming...",
    "html": "https://storage.cloro.dev/results/c45a5081-808d-4ed3-9c86-e4baf16c8ab8/page-1.html",
    "sources": [
      {
        "position": 1,
        "url": "https://techcrunch.com/laptops",
        "label": "TechCrunch",
        "description": "Latest laptop reviews and recommendations"
      }
    ],
    "markdown": "Based on current sources and information, here are the best laptops for programming...",
    "related_queries": [
      "best neighborhoods to stay in Lisbon",
      "top-rated luxury hotels in Lisbon under €300",
      "highest-rated traditional Portuguese restaurants in Baixa"
    ],
    "videos": [
      {
        "title": "Best hotels in Lisbon, reviewed | The Independent",
        "url": "https://www.independent.co.uk/travel/europe/portugal/lisbon/best-lisbon-portugal-hotels-b1987832.html",
        "thumbnail": "https://d2u1z1lopyfwlx.cloudfront.net/thumbnails/636fbd12-6dee-5f44-a76d-fe7f9cd20e40/75ce41cb-6767-5082-a330-ee97c5866886.jpg",
        "medium": "image",
        "source": "web",
        "image_width": 5600,
        "image_height": 3733,
        "thumbnail_width": 300,
        "thumbnail_height": 200
      }
    ],
    "images": [
      {
        "title": "Best hotels in Lisbon, reviewed | The Independent",
        "url": "https://www.independent.co.uk/travel/europe/portugal/lisbon/best-lisbon-portugal-hotels-b1987832.html",
        "thumbnail": "https://d2u1z1lopyfwlx.cloudfront.net/thumbnails/636fbd12-6dee-5f44-a76d-fe7f9cd20e40/75ce41cb-6767-5082-a330-ee97c5866886.jpg",
        "medium": "image",
        "source": "web",
        "image_width": 5600,
        "image_height": 3733,
        "thumbnail_width": 300,
        "thumbnail_height": 200
      }
    ],
    "hotels": [
      {
        "name": "Corpo Santo Lisbon Historical Hotel",
        "url": "https://www.tripadvisor.com/Hotel_Review-g189158-d12659702-Reviews-Corpo_Santo_Lisbon_Historical_Hotel-Lisbon_District_Central_Portugal.html",
        "rating": 4.9,
        "num_reviews": 4374,
        "address": [
          "Largo do Corpo Santo, 25, Lisbon 1200-129 Portugal"
        ],
        "phone": "+351 21 828 8000",
        "description": "Located next to the riverside area, in one of the prime areas of the Lisbon Center...",
        "image_url": "https://media-cdn.tripadvisor.com/media/photo-o/30/28/6c/86/caption.jpg",
        "images": [
          "<string>"
        ],
        "lat": 38.707397,
        "lng": -9.142318,
        "price_level": "<string>",
        "categories": [
          "Hotel"
        ]
      }
    ],
    "places": [
      {
        "name": "Floresta Das Escadinhas",
        "url": "https://www.tripadvisor.com/Restaurant_Review-g189158-d1520116-Reviews-Floresta_Das_Escadinhas-Lisbon_District_Central_Portugal.html",
        "rating": 4.8,
        "address": [
          "Rua de Santa Justa N°3, Lisbon 1100-483 Portugal"
        ],
        "lat": 38.712717,
        "lng": -9.136362,
        "categories": [
          "Healthy",
          "Grill",
          "Barbecue",
          "Mediterranean",
          "Portuguese",
          "European"
        ],
        "map_url": "https://google.com/maps/?q=find+best+hotels+and+restaurants+in+lisbon&ll=38.720914,-9.147162&z=15",
        "images": [
          "<string>"
        ]
      }
    ],
    "shopping_cards": [
      {
        "products": [
          {
            "title": "Nike Court Vision Low Next Nature Shoes",
            "url": "https://www.amazon.in/Nike-Court-Vision-Shoes/dp/B098F6QPLK?utm_source=chatgpt.com",
            "description": "Classic sneaker with modern comfort features",
            "price": "$79.99",
            "original_price": "$99.99",
            "featured_tag": "stylish casual leather sneaker",
            "rating": 4.5,
            "num_reviews": 8703,
            "image_urls": [
              "<string>"
            ],
            "id": "prod_12345",
            "variants": "<unknown>",
            "offers": [
              {
                "merchant_name": "Amazon.in",
                "merchant_subtitle": "<string>",
                "product_name": "Nike Men's Court Vision Low Next Nature Shoes",
                "url": "https://www.amazon.in/dp/B098F6QPLK?utm_source=chatgpt.com",
                "price": "$79.99",
                "details": "In stock online, Free delivery",
                "original_price": "<string>",
                "available": true,
                "checkoutable": false,
                "is_digital": true,
                "checkout_payload": "<string>",
                "checkout_image_urls": [
                  "<string>"
                ],
                "shop_id": "<string>",
                "provider": "p2",
                "price_details": {
                  "display_price": "<string>",
                  "base": "$79.99",
                  "shipping": "<string>",
                  "tax": "<string>",
                  "total": "$79.99"
                },
                "tag": {
                  "text": "Best price",
                  "tooltip": "<string>"
                }
              }
            ],
            "rating_grouped_citation": {
              "title": "Nike Men's Court Vision Low Next Nature Shoes",
              "url": "https://www.amazon.in/dp/B098F6QPLK",
              "supporting_websites": [
                {}
              ]
            },
            "provider": "deprecated",
            "providers": [
              "product_info"
            ],
            "productLookupKey": {
              "data": "<string>"
            },
            "productLookupData": {
              "requestQuery": "<string>",
              "allIds": {},
              "metadataSources": [
                "<string>"
              ]
            },
            "showcaseMetadata": "<unknown>",
            "showPriceDisclosure": false,
            "analyticsMeta": {
              "productEventUuid": "<string>"
            },
            "metadataSources": [
              "p2"
            ],
            "productEventUuid": "<string>"
          }
        ],
        "tags": [
          "electronics",
          "gadgets"
        ]
      }
    ],
    "search_model_queries": [
      {
        "query": "find best hotels and restaurants in lisbon",
        "engine": "web",
        "limit": 8
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.cloro.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The Perplexity endpoint extracts structured data from Perplexity AI with real-time web sources. Beyond basic text responses, it automatically detects and extracts data objects including shopping products, media content, travel information, and location data based on query intent.
Web search enabledThis endpoint uses Perplexity’s default interface, which always performs web searches for all requests to provide real-time information with source citations.
The endpoint automatically detects different types of queries:

​
Request parameters

Uses common parameters. Endpoint-specific options:
  • include.rawResponse (boolean): Include raw streaming response events. Defaults to false

​
Response objects

The response includes the following sections. See each subpage for the full schema and examples.
SectionDescription
SourcesSource citations referenced in the response
Shopping cardsProduct cards with pricing, ratings, and offers
MediaVideos and images relevant to the query
Travel and placesHotels and places when travel intent is detected

​
Response schema

Includes common response fields plus:

​
Core response fields

FieldTypeDescription
result.textstringPerplexity’s response text
result.htmlstringResponse formatted in HTML (included when include.html is true)
result.sourcesarrayArray of sources referenced in the response
result.markdownstringResponse formatted in Markdown (included when include.markdown is true)
result.rawResponsearrayArray of Perplexity’s streamed response events (included when include.rawResponse is true)
result.shopping_cardsarrayShopping cards when shopping intent detected
result.videosarrayVideos relevant to the query
result.imagesarrayImages relevant to the query
result.hotelsarrayHotels when travel intent detected
result.placesarrayPlaces when location intent detected

​
Additional response data

FieldTypeDescription
result.related_queriesarraySuggested follow-up search queries
result.search_model_queriesarrayInternal search queries (fan-outs) used to generate response
Each search model query (fan-out) includes:
FieldTypeDescription
querystringActual search query used
enginestringSearch engine type (“web”, etc.)
limitnumberResult limit (typically 8)

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request parameters for monitoring Perplexity responses

​
prompt
string
required

The prompt to send to Perplexity

Required string length: 1 - 10000
Example:

"What are the best laptops for programming?"

​
country
string
default:US

Country/region code for localized response

Example:

"US"

​
include
object

Optional flags for including additional response formats

Response

successful Perplexity monitoring response

​
success
boolean
required
Example:

true

​
result
object
required

Perplexity response data