エンドポイント：POST https://api.microsoft.ai/v3/search/images
サンプル要求:
curl -X POST "https://api.microsoft.ai/v3/search/images" \
-H "host: api.microsoft.ai" \
-H "x-apikey: <Your key>" \
-H 'content-type: application/json' \
-d '{
"query": "cats",
"maxResults": 2,
"language": "en",
"region": "US"
}'
Parameters
| パラメーター |
Required |
タイプ |
Default |
Description |
query |
はい |
文字列 |
- |
検索クエリ文字列。 最大長は 1000 文字です。 |
maxResults |
いいえ |
整数 |
30 |
返される結果の最大数。 既定値は 30、最大値は 30 です。 |
language |
いいえ |
文字列 |
"en" |
検索結果のインターフェイス言語の 2 文字の ISO 639-1 言語コード。 完全な一覧については、「 サポートされている言語 」を参照してください。 |
region |
いいえ |
文字列 |
"US" |
結果の取得元となる 2 文字の国/地域コード (例: "US"、"JP"、"CN")。 完全な一覧については、「 サポートされているリージョン 」を参照してください。 |
aspectRatio |
いいえ |
string(enum) |
- |
縦横比で画像をフィルター処理します。 値: "square" (約 1:1)、"wide" (幅 > 高さ)、"tall" (高さ > 幅)。 設定しない場合、フィルター処理は適用されません。 |
color |
いいえ |
string(enum) |
- |
画像の色で画像をフィルター処理します。 値: "colorOnly" (色の画像のみを返す)、"モノクロ" (白黒の画像のみを返します)。 設定しない場合、フィルター処理は適用されません。 |
safeSearch |
いいえ |
string(enum) |
"strict" |
安全な検索フィルター処理のレベル。 値: "off"、"strict"。 既定値は "strict" です。 |
imageSize |
いいえ |
string(enum) |
- |
サイズ カテゴリで画像をフィルター処理します。 値: "small" (<200x200px)、"medium" (幅または高さが 200 から 500px)、"large" (幅または高さ >=500px)、"extraLarge" (>1024x768px)。 カスタム境界にピクセル制約 (maxHeight、minHeight、maxWidth、minWidth) を使用することもできます。ピクセル制約は、競合する場合に imageSize よりも優先されます。 設定しない場合、フィルター処理は適用されません。 |
watermarkFree |
いいえ |
boolean |
偽り |
透かしのある画像を除外します。 既定値は falseです。 |
maxHeight |
いいえ |
整数 |
- |
画像の最大高さ (ピクセル単位)。 カスタム境界の imageSize と共に使用されます。 |
minHeight |
いいえ |
整数 |
- |
最小イメージの高さ (ピクセル単位)。 |
maxWidth |
いいえ |
整数 |
- |
画像の最大幅 (ピクセル単位)。 |
minWidth |
いいえ |
整数 |
- |
最小イメージ幅 (ピクセル単位)。 |
| Field |
タイプ |
Description |
| ホスティング |
文字列 |
Microsoft AI API のホスト: api.microsoft.ai。 |
| x-apikey または Authorization |
文字列 |
認証用の API キーまたはEntra IDアクセス トークン。 |
| コンテンツタイプ |
文字列 |
要求本文の MIME の種類。
application/json を使用してください。 |
応答
ImagesResponse
| Field |
タイプ |
Description |
imageResults |
ImageResult の配列 |
画像の結果の一覧。 |
instrumentationClickBase |
文字列 |
クリック ping 要求のベース URL。 結果項目から instrumentationSuffix 値を追加して、完全な ping URL を形成します。 EnableInstrumentationPing プロファイル フラグを持つアプリケーションにのみ存在します。 注: ユーザーのクリックは、URL リダイレクトを使用してログに記録することもできます。 リダイレクトが有効になっている場合、ユーザーのクリックをログに記録するためのアクションは必要なく、 instrumentationClickBase は応答に含まれません。 セットアップ手順については、 インストルメンテーション ガイド を参照してください。 |
instrumentationCitationBase |
文字列 |
LLM ログ ping 要求のベース URL。 完全な ping URL を形成する DATA ペイロードを追加します。 EnableInstrumentationPing プロファイル フラグを持つアプリケーションにのみ存在します。 |
traceId |
文字列 |
デバッグと追跡のトレース ID。 |
ImageResult
| Field |
タイプ |
Description |
title |
文字列 |
イメージのタイトル。 |
url |
文字列 |
イメージのソース URL。 URL リダイレクトが有効になっている中国のユーザーの場合、このフィールドには clickUrlと同じリダイレクト URL が代わりに含まれます。 |
domain |
文字列 |
結果の宛先ホスト。 URL リダイレクトが有効になっている中国のユーザーに対してのみ返されます。 |
hostPageUrl |
文字列 |
イメージをホストする Web ページの URL。 |
caption |
文字列 |
生成されたイメージの説明。 |
width |
整数 |
イメージの幅 (ピクセル単位)。 |
height |
整数 |
画像の高さ (ピクセル単位)。 |
thumbnailUrl |
文字列 |
画像のサムネイル ソース URL。 |
lastUpdatedAt |
文字列 |
イメージの最終更新日は、ISO8601形式に従います。 |
isAdult |
boolean |
コンテンツが成人コンテンツかどうかを示します。 |
clickUrl |
文字列 |
クリックをプロキシするリダイレクト URL Bing。 クリック リダイレクトが有効な場合にのみ存在します。 |
instrumentationSuffix |
文字列 |
この結果項目のインストルメンテーション ping URL ベースに追加するサフィックス。 インストルメンテーション ping URL と clickUrl リダイレクトの両方の K 値として使用されます。 インストルメンテーション ping が有効な場合に表示されます。 |
エラー コード
| 状態コード |
エラー カテゴリ |
Description |
一般的な原因 |
| 200 |
成功 |
要求は成功しました。 |
- |
| 400 |
正しくない要求 |
要求パラメーターが無効です。 |
必須フィールドが見つからない、無効なパラメーター値、形式が正しくない JSON |
| 401 |
Unauthorized |
認証に失敗したか、見つかりません。 |
無効な API キー、x-apikey ヘッダーがありません |
| 403 |
許可されていません |
有効な資格情報ですが、アクセス許可が不十分です。 |
API キーに必要なアクセス許可がない |
| 410 |
使用されていないリソース (Gone) |
HTTPS が必要です。 |
HTTPS ではなく HTTP 経由で行われた要求 |
| 415 |
サポートされていないメディアの種類 |
コンテンツ タイプはサポートされていません。 |
コンテンツ タイプ ヘッダーが見つからないか、正しくない |
| 429 |
要求が多すぎます |
レート制限を超えました。 |
時間枠内の要求が多すぎます |
| 500 |
サーバー内部エラー |
予期しないサーバー エラー。 |
一時的なサーバーの問題 |
| 503 |
サービス利用不可 |
サービスは一時的に使用できません。 |
メンテナンスまたは一時的な停止 |
| 504 |
ゲートウェイのタイムアウト |
リクエストがタイムアウトしました。 |
アップストリーム サービスのタイムアウト |
エラー処理のガイダンスの詳細については、「 エラー処理」を参照してください。
Web Search | Videos Search | Browse | News Search | MCPも参照してください。