Skip to main content
POST
/
v1
/
monitor
/
copilot
Monitor Copilot Responses
curl --request POST \
  --url https://api.cloro.dev/v1/monitor/copilot \
  --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": "As an AI assistant, I can help you find great laptops for programming...",
    "html": "https://storage.cloro.dev/results/c45a5081-808d-4ed3-9c86-e4baf16c8ab8/page-1.html",
    "sources": [
      {
        "position": 1,
        "url": "https://docs.microsoft.com/",
        "label": "Microsoft Docs",
        "description": "Official development documentation"
      }
    ],
    "shoppingCards": [
      {
        "type": "shoppingProducts",
        "layout": "Carousel",
        "products": [
          {
            "product": {
              "id": "<string>",
              "groupId": "<string>",
              "brandGroupId": "<string>"
            },
            "offerId": "<string>",
            "url": "<string>",
            "name": "<string>",
            "description": "<string>",
            "images": [
              {
                "title": "<string>",
                "url": "<string>"
              }
            ],
            "specifications": [
              {
                "displayName": "<string>",
                "values": [
                  "<string>"
                ]
              }
            ],
            "tags": [
              "<string>"
            ],
            "price": {
              "amount": 123,
              "currency": "<string>",
              "currencySymbol": "<string>"
            },
            "seller": "<string>",
            "sellerLogoUrl": "<string>",
            "brandName": "<string>",
            "rating": {
              "value": 123,
              "count": 123
            },
            "canTrackPrice": true
          }
        ]
      }
    ],
    "map": [
      {
        "name": "WonderWorks Pigeon Forge",
        "position": 1,
        "placeId": "ChIJEYpTsk__W4gR2sQLGzOjE3o",
        "location": {
          "address": "100 Music Rd, Pigeon Forge, TN 37863",
          "latitude": 35.823257,
          "longitude": -83.5787498
        },
        "phoneNumber": "(865) 868-1800",
        "url": "http://www.wonderworksonline.com/pigeon-forge/",
        "reviews": [
          {
            "count": 10625,
            "rating": 4.3,
            "providerName": "Google",
            "providerIconUrl": null,
            "url": "https://maps.google.com/?cid=8796553937077126362"
          }
        ],
        "photos": [
          {
            "url": "https://lh3.googleusercontent.com/gps-cs-s/example",
            "altText": null,
            "providerName": null,
            "providerUrl": "https://maps.google.com"
          }
        ],
        "openState": "Open · Closes 9 PM",
        "category": "Amusement park",
        "price": null,
        "layerLabel": "Theme Parks"
      }
    ],
    "markdown": "As an AI assistant, I can help you find great laptops for programming..."
  }
}

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 Microsoft Copilot endpoint extracts structured data from Microsoft Copilot with shopping cards for product tracking. Useful for development tools, Microsoft ecosystem research, and enterprise-focused queries.
Web search enabledThis endpoint uses Copilot’s default interface, which always performs web searches for all requests to provide real-time information with source citations.

​
Request parameters

Uses common parameters. Endpoint-specific options:
  • include.markdown (boolean): Include markdown-formatted response. Defaults to false
  • 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 seller info
Map entriesBusiness and place information with reviews and photos

​
Response schema

Includes common response fields plus:
FieldTypeDescription
result.sourcesarrayArray of sources referenced in the response
result.shoppingCardsarrayArray of shopping card objects with product information (automatically included when available)
result.maparrayArray of map entry objects with business/place information (automatically included when available)
result.markdownstringResponse formatted in Markdown (included when include.markdown is true)
result.rawResponsearrayArray of Copilot’s streamed response events (included when include.rawResponse is true)

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 Copilot responses

​
prompt
string
required

The prompt to send to Copilot

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 Copilot monitoring response

​
success
boolean
required
Example:

true

​
result
object
required

Copilot response data