REST API リファレンスを参照する

エンドポイント：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 はい 文字列 - 参照する Web ページの URL。
マックスレングス いいえ 整数 10000 応答のコンテンツ フィールドの最大文字数。 最大値は 5,0000 文字です。
liveCrawl いいえ 文字列 "none" ライブ クロール動作を制御します。 値: "none" (インデックス付きコンテンツのみを返す)、"フォールバック" (インデックスに URL が見つからない場合はクロール)、"force" (インデックス付きコンテンツが存在する場合でも新しいクロールを要求します)。 "none" 値の場合、インデックスに URL が見つからない場合、API は 404 エラー コード (URL が見つかりません) を返します。
includeWebLinks いいえ boolean 偽り ページからの送信ハイパーリンクを含めます。
renderDynamicPages いいえ boolean 偽り 動的コンテンツのスクリーンショットに対して JavaScript レンダリングを有効にします。 liveCrawl が "フォールバック" に設定されている場合にのみ機能します。
includeImageLinks いいえ boolean 偽り ページの画像 URL を含めます。
言語 いいえ 文字列 "en" 言語コード (2 文字の ISO 639-1)。 完全な一覧については、「 サポートされている言語 」を参照してください。
リージョン いいえ 文字列 "US" 地域コード (2 文字の国/地域コード)。 完全な一覧については、「 サポートされているリージョン 」を参照してください。
コンテンツフォーマット いいえ 文字列 "html" 返す Web ページ コンテンツの形式。 "text"、"html"、または "markdown" を指定できます。

要求ヘッダー

Field タイプ Description
ホスティング 文字列 Microsoft AI API のホスト: api.microsoft.ai。
x-apikey または Authorization 文字列 認証用の API キーまたはEntra IDアクセス トークン。
コンテンツタイプ 文字列 要求本文の MIME の種類。 application/json を使用してください。

応答

Field タイプ Description
url 文字列 Web ページの URL。
title 文字列 ウェブページのタイトル。
コンテンツ 文字列 Web ページの抽出されたコンテンツ (別名グラウンド)。
lastUpdatedAt 文字列 Web ページの最終更新日は、ISO8601形式に従います。
crawledAt 文字列 Web ページの最後のクロール日は、ISO8601形式に従います。
liveCrawlSucceeded boolean (省略可能) liveCrawl: "force"で成功した要求が古いページを返した場合にのみ、falseとして存在します。 古いページでない場合は省略されます。は trueとして出力されません。 "none"、"fallback"、省略/null モード、再試行 (202) 応答では省略されます。
traceId 文字列 デバッグ用のトレース ID。
retryAfter 文字列 再試行前の待機時間。 "s" サフィックスを持つ期間 (たとえば、 "60s" は 60 秒待機を意味します)。 オンデマンド クロールが進行中の場合にのみ存在します。
isAdult boolean Web ページに成人用コンテンツが含まれているかどうかを示します。

Note

title、content、isAdult、lastUpdatedAt、およびcrawledAtの各フィールドは、成功した (200) 応答にのみ存在します。 再試行 (202) 応答からは省略されます。

たとえば、 "liveCrawl": "force" が成功した要求には、古いコンテンツが返された場合にのみ "liveCrawlSucceeded": false が含まれます。 古いページ以外のページでは、 trueを返すのではなく、このフィールドが省略されます。 このフィールドは、MCP 参照ツールの構造化応答でも同じ意味を持ちます。

エラー コード

状態コード エラー カテゴリ Description 一般的な原因
200 成功 要求は成功しました。 -
202 承認済み 処理を受け入れた要求 (ライブ クロール)。 進行中のオンデマンド クロール
400 正しくない要求 要求パラメーターが無効です。 必須フィールドが見つからない、無効なパラメーター値、形式が正しくない JSON
401 Unauthorized 認証に失敗したか、見つかりません。 無効な API キー、x-apikey ヘッダーがありません
403 許可されていません 有効な資格情報ですが、要求を満たすことはできません。 API キーに必要なアクセス許可がない、ポリシーによってブロックされた URL、フィルター処理されたコンテンツ
404 見つかりません ドキュメントが見つかりません。 無効またはアクセスできない URL
410 使用されていないリソース (Gone) HTTPS が必要です。 HTTPS ではなく HTTP 経由で行われた要求
415 サポートされていないメディアの種類 コンテンツ タイプはサポートされていません。 コンテンツ タイプ ヘッダーが見つからないか、正しくない
429 要求が多すぎます レート制限を超えました。 時間枠内の要求が多すぎます
430 オンデマンド クロールが多すぎます オンデマンド クロールが多すぎます。 過剰なライブ クロール要求
500 サーバー内部エラー 予期しないサーバー エラー。 一時的なサーバーの問題
503 サービス利用不可 サービスは一時的に使用できません。 メンテナンスまたは一時的な停止
504 ゲートウェイのタイムアウト リクエストがタイムアウトしました。 アップストリーム サービスのタイムアウト

エラー処理のガイダンスの詳細については、「 エラー処理」を参照してください。

Web Search | Videos Search | News Search | Images Search | MCPも参照してください。

  • 最終更新: