Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrapellm.com/llms.txt

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

The Copilot endpoint sends any prompt to Microsoft Copilot and returns the response as structured JSON across five distinct modes: search, smart, chat, reasoning, and study. Each mode produces a meaningfully different response style.
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. The study 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[]

​
Request parameters

​
prompt
string
required
The prompt to send to Copilot. Maximum 4,000 characters.
​
country
string
default:"US"
ISO 3166-1 alpha-2 country code. JP and TW are not supported.
​
mode
string
default:"search"
Copilot response mode. See modes table below.
​
bypass_cache
boolean
default:"false"
Skip the response cache and always fetch a fresh result.
​
timeout
float
default:"300"
Maximum seconds to wait for Copilot to respond (10–600).

​
Modes

ModeDescription
searchWeb-grounded answer with cited sources (default)
smartBalanced blend of web search and reasoning
chatQuick direct reply with no web search
reasoningSlower, deeper analysis for complex questions
studyStructured study guide format
3 credits per request

​
Example request

curl "https://api.scrapellm.com/scrapers/copilot" \
  -H "X-API-Key: YOUR_API_KEY" \
  -G \
  --data-urlencode "prompt=What brands do marketers recommend for email automation?" \
  --data-urlencode "country=US" \
  --data-urlencode "mode=search"

​
Response schema

Includes common response fields plus:
FieldTypeDescription
resultstringPlain-text response from Copilot
result_markdownstringMarkdown-formatted response
modestringThe mode used for this response
citationsarrayNamed sources cited — each has title and url
citations[].titlestringArticle title of the cited source
citations[].urlstringURL of the cited source
linksarrayAll outbound links surfaced in the response
credits_usedintegerCredits consumed — always 3 for Copilot
elapsed_msfloatEnd-to-end request duration in milliseconds
cachedbooleantrue if served from cache

​
Common questions

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.