Copilot Scraper
Use scraper.copilot to capture answers generated by Microsoft Copilot across search, chat, reasoning, and study modes. The actor returns the Markdown answer plus every citation Copilot surface.
Request Example
curl '{api_host}/api/v2/scraper/request' \
--header 'Content-Type: application/json' \
--header 'x-api-token: {you_api_key}' \
--data '{
"actor": "scraper.copilot",
"input": {
"prompt": "Recommended attractions in New York",
"country": "US",
"mode": "search"
},
"webhook": {
"url": "http://www.youwebhook.com"
}
}'Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
prompt | string | Yes | Prompt sent to Copilot. |
country | string | Yes | Country or region code (JP and TW are not available). |
mode | string | Yes | Mode to run: search, smart, chat (Quick response), reasoning (Think Deeper), or study (Study and learn). |
Response Fields
| Parameter | Type | Description |
|---|---|---|
result_text | string | Markdown body Copilot generated. |
prompt | string | Original prompt. |
mode | string | Mode used: search, smart, chat, reasoning, or study. |
links | array | All outbound links returned by Copilot. |
citations | array | Citation objects extracted from the response. |
citations.title | string | Title of the cited source. |
citations.url | string | URL of the cited source. |