Scrapers
Copilot
Extract structured data from the Microsoft Copilot web interface - citations and links across five distinct response modes - as clean JSON.
GET
/
scrapers
/
copilot
cURL
# Streaming can take up to 300s - --max-time matches the server timeout
curl --max-time 300 \
-G "https://api.scrapellm.com/scrapers/copilot" \
--data-urlencode "api_key=YOUR_API_KEY" \
--data-urlencode "prompt=What brands do marketers recommend for email automation?" \
--data-urlencode "country=US" \
--data-urlencode "mode=search"import requests
response = requests.get(
"https://api.scrapellm.com/scrapers/copilot",
params={
"api_key": "YOUR_API_KEY",
"prompt": "What brands do marketers recommend for email automation?",
"country": "US",
"mode": "search",
}
)
print(response.json())
const params = new URLSearchParams({
api_key: "YOUR_API_KEY",
prompt: "What brands do marketers recommend for email automation?",
country: "US",
mode: "search",
});
const response = await fetch(
`https://api.scrapellm.com/scrapers/copilot?${params}`
);
const data = await response.json();
console.log(data);
const params = new URLSearchParams({
api_key: "YOUR_API_KEY",
prompt: "What brands do marketers recommend for email automation?",
country: "US",
mode: "search",
});
const response = await fetch(
`https://api.scrapellm.com/scrapers/copilot?${params}`
);
const data = await response.json();
console.log(data);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrapellm.com/scrapers/copilot",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.scrapellm.com/scrapers/copilot"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.scrapellm.com/scrapers/copilot")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrapellm.com/scrapers/copilot")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"scraper": "copilot",
"status": "done",
"job_id": "job_abc123",
"prompt": "What brands do marketers recommend for email automation?",
"country": "US",
"mode": "search",
"result": "Marketers commonly recommend Mailchimp, HubSpot, and Klaviyo...",
"result_markdown": "Marketers commonly recommend **Mailchimp**, **HubSpot**, and **Klaviyo**...",
"citations": [
{
"title": "Best Email Marketing Tools 2025",
"url": "https://example.com/email-tools"
},
{
"title": "Klaviyo vs Mailchimp Comparison",
"url": "https://example.com/comparison"
}
],
"links": [
"https://mailchimp.com",
"https://hubspot.com",
"https://klaviyo.com"
],
"credits_used": 3,
"elapsed_ms": 9102.4,
"cached": false,
"markdown_url": "https://scrapellm.com/md/job_abc123.md"
}{
"detail": "Missing API key. Pass your key in the X-API-Key header or as ?api_key= in the URL."
}{
"detail": "Invalid API key."
}{
"detail": "Invalid API key."
}{
"detail": "Invalid API key."
}{
"detail": "Invalid API key."
}{
"detail": "Invalid API key."
}Five response modesCopilot is the only scraper with switchable response modes. Use
search for cited web answers, reasoning for deep analysis, and study for structured educational content.Overview
Use this endpoint to track brand mentions in Microsoft’s AI ecosystem, run structured research across different answer styles, and monitor how Copilot responds to industry queries. Thestudy mode is particularly useful for generating structured content briefs.
Unique features
- Five modes: Switch between web search, smart reasoning, chat, deep reasoning, and study-guide formats
- Named citations: Cited sources with title and URL via
citations[] - Raw links: All outbound links surfaced in the response via
links[]
Modes
| Mode | Description |
|---|---|
search | Web-grounded answer with cited sources (default) |
smart | Balanced blend of web search and reasoning |
chat | Quick direct reply with no web search |
reasoning | Slower, deeper analysis for complex questions |
study | Structured study guide format |
Example request
# Streaming can take up to 300s - --max-time matches the server timeout
curl --max-time 300 \
-G "https://api.scrapellm.com/scrapers/copilot" \
--data-urlencode "api_key=YOUR_API_KEY" \
--data-urlencode "prompt=What brands do marketers recommend for email automation?" \
--data-urlencode "country=US" \
--data-urlencode "mode=search"
import requests
response = requests.get(
"https://api.scrapellm.com/scrapers/copilot",
headers={"X-API-Key": "YOUR_API_KEY"},
params={
"prompt": "What brands do marketers recommend for email automation?",
"country": "US",
"mode": "search",
}
)
print(response.json())
const params = new URLSearchParams({
prompt: "What brands do marketers recommend for email automation?",
country: "US",
mode: "search",
});
const response = await fetch(
`https://api.scrapellm.com/scrapers/copilot?${params}`,
{ headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const data = await response.json();
Response schema
Includes common response fields plus:| Field | Type | Description |
|---|---|---|
result | string | Plain-text response from Copilot |
result_markdown | string | Markdown-formatted response |
mode | string | The mode used for this response |
citations | array | Named sources cited - each has title and url |
citations[].title | string | Article title of the cited source |
citations[].url | string | URL of the cited source |
links | array | All outbound links surfaced in the response |
credits_used | integer | Credits consumed - always 3 for Copilot |
elapsed_ms | float | End-to-end request duration in milliseconds |
cached | boolean | true if served from cache |
Common questions
What is the difference between citations and links?
citations are the named sources Copilot explicitly attributes in its answer (with titles). links are all outbound URLs surfaced in the response - including links within the answer body that may not be formal citations.
Which mode is best for brand monitoring?
search mode - it’s web-grounded and always includes citations, making it the most reliable for tracking which sources Copilot recommends for any industry query.
When should I use reasoning mode?
For complex, multi-part questions where you need analytical depth - competitive analysis, strategy questions, or topics requiring Copilot to weigh multiple factors. Responses take longer but are more thorough.
Are JP and TW supported?
No. Japan and Taiwan are not currently supported. Use any other ISO 3166-1 alpha-2 country code.Authorizations
ApiKeyHeaderApiKeyQuery
Query Parameters
Copilot response mode:
search— web-grounded answer with cited sources (default)smart— balanced blend of web search and reasoningchat— quick direct reply, no web searchreasoning— slower, deeper analysis for complex questionsstudy— structured study guide format
Available options:
search, smart, chat, reasoning, study Response
Scrape completed successfully.
cURL
# Streaming can take up to 300s - --max-time matches the server timeout
curl --max-time 300 \
-G "https://api.scrapellm.com/scrapers/copilot" \
--data-urlencode "api_key=YOUR_API_KEY" \
--data-urlencode "prompt=What brands do marketers recommend for email automation?" \
--data-urlencode "country=US" \
--data-urlencode "mode=search"import requests
response = requests.get(
"https://api.scrapellm.com/scrapers/copilot",
params={
"api_key": "YOUR_API_KEY",
"prompt": "What brands do marketers recommend for email automation?",
"country": "US",
"mode": "search",
}
)
print(response.json())
const params = new URLSearchParams({
api_key: "YOUR_API_KEY",
prompt: "What brands do marketers recommend for email automation?",
country: "US",
mode: "search",
});
const response = await fetch(
`https://api.scrapellm.com/scrapers/copilot?${params}`
);
const data = await response.json();
console.log(data);
const params = new URLSearchParams({
api_key: "YOUR_API_KEY",
prompt: "What brands do marketers recommend for email automation?",
country: "US",
mode: "search",
});
const response = await fetch(
`https://api.scrapellm.com/scrapers/copilot?${params}`
);
const data = await response.json();
console.log(data);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrapellm.com/scrapers/copilot",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.scrapellm.com/scrapers/copilot"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.scrapellm.com/scrapers/copilot")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrapellm.com/scrapers/copilot")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"scraper": "copilot",
"status": "done",
"job_id": "job_abc123",
"prompt": "What brands do marketers recommend for email automation?",
"country": "US",
"mode": "search",
"result": "Marketers commonly recommend Mailchimp, HubSpot, and Klaviyo...",
"result_markdown": "Marketers commonly recommend **Mailchimp**, **HubSpot**, and **Klaviyo**...",
"citations": [
{
"title": "Best Email Marketing Tools 2025",
"url": "https://example.com/email-tools"
},
{
"title": "Klaviyo vs Mailchimp Comparison",
"url": "https://example.com/comparison"
}
],
"links": [
"https://mailchimp.com",
"https://hubspot.com",
"https://klaviyo.com"
],
"credits_used": 3,
"elapsed_ms": 9102.4,
"cached": false,
"markdown_url": "https://scrapellm.com/md/job_abc123.md"
}{
"detail": "Missing API key. Pass your key in the X-API-Key header or as ?api_key= in the URL."
}{
"detail": "Invalid API key."
}{
"detail": "Invalid API key."
}{
"detail": "Invalid API key."
}{
"detail": "Invalid API key."
}{
"detail": "Invalid API key."
}