API Reference › AI Mode › Extract Microsoft Copilot

Extract Microsoft Copilot

Send a prompt to Microsoft Copilot and receive its answer parsed into a predictable JSON shape — text, cited sources, shopping cards, and place entries all broken out into typed fields you can consume directly.

POST https://api.cloro.cloud/v1/monitor/copilot

Overview

This endpoint drives a real Copilot session on your behalf and captures the response as structured data instead of a raw HTML blob. Alongside the plain answer text, cloro extracts the citation pills Copilot surfaces, any shopping product carousels, and location results, so you can track how Microsoft products, enterprise offerings, and developer tools appear in generated answers.

Authenticate every call with a bearer token in the Authorization header and send a JSON body with Content-Type: application/json.

Request parameters

Field	Type	Description
prompt	string	The question or instruction to submit to Copilot. Required.
country	string	Two-letter country code (for example `US`) used to localize the session and its results.
include	object	Optional flags controlling which extra representations are returned in the result.
include.html	boolean	When true, a link to the captured HTML page is added to the result. Defaults to false.
include.markdown	boolean	When true, a Markdown rendering of the answer is included. Defaults to false.
include.rawResponse	boolean	When true, the unprocessed upstream payload is attached. Defaults to false.

Response fields

Field	Type	Description
success	boolean	Indicates whether the extraction completed successfully.
result.text	string	Copilot's answer as plain text.
result.html	string	URL to the stored HTML capture, present only when requested.
result.sources	array	Reference links Copilot drew on, each with position, url, label, and description.
result.citationPills	array	Inline citation chips shown in the answer, including label, url, domain, description, and position.
result.shoppingCards	array	Product carousels, each holding a layout and a list of products with pricing, images, specifications, seller, and rating.
result.map	array	Place entries with name, address, coordinates, contact details, reviews, and photos.
result.searchQueries	array	Underlying search queries Copilot ran while composing the answer.
result.markdown	string	Markdown rendering of the answer, present only when requested.

Response example

{
  "success": true,
  "result": {
    "text": "Here are some strong laptop options for software development...",
    "sources": [
      {
        "position": 1,
        "url": "https://docs.microsoft.com/",
        "label": "Microsoft Docs",
        "description": "Official development documentation"
      }
    ],
    "citationPills": [
      {
        "label": "Microsoft 365 Documentation",
        "citationPillId": 1,
        "url": "https://docs.microsoft.com/",
        "domain": "docs.microsoft.com",
        "description": "Official development documentation",
        "position": 1
      },
      {
        "label": "VS Code on GitHub",
        "citationPillId": 2,
        "url": "https://github.com/microsoft/vscode",
        "domain": "github.com",
        "description": "Visual Studio Code repository",
        "position": 2
      }
    ],
    "shoppingCards": [
      {
        "type": "shoppingProducts",
        "layout": "Carousel",
        "products": [
          {
            "product": {
              "id": "prod_8812",
              "groupId": "grp_204",
              "brandGroupId": "brand_57"
            },
            "position": 1,
            "offerId": "offer_33019",
            "url": "https://example-retailer.com/dev-laptop-16",
            "name": "DevBook Pro 16",
            "description": "16-inch developer laptop with 32GB RAM",
            "images": [
              { "title": "Front view", "url": "https://img.example.com/devbook-front.jpg" }
            ],
            "specifications": [
              { "displayName": "Memory", "values": ["32GB"] }
            ],
            "tags": ["free-shipping"],
            "price": {
              "amount": 1899,
              "currency": "USD",
              "currencySymbol": "$"
            },
            "seller": "Example Retailer",
            "sellerLogoUrl": "https://img.example.com/seller.png",
            "brandName": "DevBook",
            "rating": { "value": 4.6, "count": 214 },
            "canTrackPrice": true
          }
        ]
      }
    ],
    "map": [],
    "searchQueries": [
      "best laptops for programming 2025",
      "developer laptop reviews"
    ]
  }
}

Notes

Fields that depend on the include flags — html, markdown, and the raw payload — are omitted unless you opt in. Array fields such as shoppingCards, map, and citationPills may be empty when Copilot's answer contains no matching content, so always guard against empty collections in client code. For help, reach us at [email protected].