端點：POST https://api.microsoft.ai/v3/browse
範例請求：
curl -X POST "https://api.microsoft.ai/v3/browse" \
-H "host: api.microsoft.ai" \
-H "x-apikey: <Your key>" \
-H "content-type: application/json" \
-d '{
"url": "https://news.microsoft.com/source/",
"maxLength": 3000,
"language": "en",
"region": "US",
"contentFormat": "html"
}'
Parameters
| 參數 | Required | 類型 | Default | Description |
|---|---|---|---|---|
| url | Yes | 字串 | - | 瀏覽網頁的網址。 |
| 最大長度 | No | 整數 | 10000 | 內容欄位中回應的最大字元數。 最大字元數為 500000 字元。 |
| 活爬行 | No | 字串 | 「沒有」 | 控制活爬行行為。 值值：「無」（僅回傳已索引內容）、「備用」（若索引中找不到 URL，則爬取）、「強制」（即使有索引內容，仍要求重新爬取）。 請注意，對於「無」值，若索引中找不到該 URL，API 會回傳 404 錯誤代碼（找不到 URL）。 |
| includeWebLinks | No | boolean | 假的 | 請附上頁面的外發超連結。 |
| renderDynamicPages | No | boolean | 假的 | 啟用 JavaScript 渲染以進行動態內容截圖。 只有在 liveCrawl 設為「備用」時才有效。 |
| includeImageLinks | No | boolean | 假的 | 請附上頁面上的圖片網址。 |
| 語言 | No | 字串 | 「en」 | 語言代碼（兩字母 ISO 639-1）。 完整列表請參閱 支援語言 。 |
| 區域 | No | 字串 | "US" | 區域代碼（兩字母國家/地區代碼）。 完整列表請參閱 支援區域 。 |
| contentFormat | No | 字串 | 「html」 | 網頁內容格式將回來。 可以是「text」、「html」或「markdown」。 |
要求標頭
| Field | 類型 | Description |
|---|---|---|
| 主持人 | 字串 | Microsoft AI API 主機： api.microsoft.ai |
| x-apikey 或 授權 | 字串 | 你的 API 金鑰或 Entra ID 存取權杖用於認證。 |
| 內容類型 | 字串 | 請求實體的 MIME 類型。 請使用 application/json。 |
回應
| Field | 類型 | Description |
|---|---|---|
| url | 字串 | 網頁的URL。 |
| title | 字串 | 網頁的標題。 |
| 內容 | 字串 | 網頁中擷取的內容（也就是接地）。 |
| 最後更新時間 | 字串 | 網頁最後更新日期依照ISO8601格式。 |
| crawledat | 字串 | 網頁最後爬取日期依ISO8601格式呈現。 |
| liveCrawl成功 | 布林值（可選） | 只有當成功請求liveCrawl: "force"回傳過時頁面時才會顯示false。 省略非過時頁面;從未以 形式發射。true 省略了 "none"、 "fallback"、 一個省略/空模式，以及重試（202）次回應。 |
| traceId | 字串 | 用於除錯的追蹤識別碼。 |
| 重試之後 | 字串 | 等待時間（Time to wait）再嘗試，格式化為以秒為單位的持續時間，並加上 "s" 後綴（例如， "60s" 表示等待 60 秒）。 只有在隨選爬行進行時才會出現。 |
| 是成人 | boolean | 顯示該網頁是否包含成人內容。 |
Note
title， content， isAdult， lastUpdatedAt， crawledAt 和 欄位僅出現在成功（200）個回應中。 重試（202）回答中未包含這些選項。
例如，成功的請求只有 "liveCrawl": "force" 在退回過時內容時才包含 "liveCrawlSucceeded": false 。 非過時頁面會省略此欄位，而非返回 true。 這個欄位在瀏覽 MCP 工具的結構化回應中也有相同的意義。
錯誤代碼
| 狀態代碼 | 錯誤類別 | Description | 常見的原因 |
|---|---|---|---|
| 200 | Success | 請求成功。 | - |
| 202 | 已接受 | 請求已接受處理（即時爬蟲）。 | 隨選爬行進行中 |
| 400 | 錯誤的請求 | 請求參數無效。 | 缺少必填欄位、參數值無效、JSON 格式錯誤 |
| 401 | Unauthorized | 驗證失敗或缺失。 | API 金鑰無效，缺少 x-apikey 標頭 |
| 403 | 禁止 | 憑證有效但無法完成申請。 | API 金鑰缺乏必要的權限，URL 被政策封鎖，內容被過濾 |
| 404 | 找不到 | 找不到文件。 | 網址無效或無法存取 |
| 410 | 消失了 | 需要 HTTPS 認證。 | 請求是透過 HTTP 而非 HTTPS 進行的 |
| 415 | 不支援媒體類型 | 內容類型不支援。 | 缺少或錯誤的內容類型標頭 |
| 429 | 過多要求 | 速率超過上限。 | 時間窗口內請求太多 |
| 430 | 太多隨選爬蟲 | 隨選爬蟲太多了。 | 過度的即時爬蟲請求 |
| 500 | 內部伺服器錯誤 | 未預期的伺服器錯誤。 | 臨時伺服器問題 |
| 503 | 服務不可用 | 服務暫時無法使用。 | 維護或暫時停電 |
| 504 | 閘道逾時 | 要求已逾時。 | 上游服務逾時 |
如需詳細的錯誤處理指引，請參見 錯誤處理。