Video Search REST API リファレンス

エンドポイント：POST https://api.microsoft.ai/v3/search/videos

サンプル要求:

curl -X POST "https://api.microsoft.ai/v3/search/videos" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "cute puppy videos",
    "maxResults": 30,
    "language": "en",
    "region": "US"
  }'

Parameters

パラメーター Required タイプ Default Description
クエリ はい 文字列 - 検索クエリ文字列。 最大長は 1000 文字です。
maxResults いいえ 整数 30 返される結果の最大数。 既定値は 30、最大値は 30 です。
言語 いいえ 文字列 "en" 検索結果のインターフェイス言語の 2 文字の ISO 639-1 言語コード。 完全な一覧については、「 サポートされている言語 」を参照してください。
リージョン いいえ 文字列 "US" 結果の取得先の 2 文字の国/地域コード (例: "US"、"JP"、"GB")。 完全な一覧については、「 サポートされているリージョン 」を参照してください。
enablePlaylist いいえ boolean 偽り 再生リストの結果を応答に含めるかどうか。
freshness いいえ 文字列 - 検出日に基づいて結果をフィルター処理する時間範囲。 "week"、"month"、または ISO 8601 日付間隔形式 ("YYYY-MM-DD/YYYY-MM-DD" または "YYYY-MM-DDTHH:mm:ssZ/YYYY-MM-DDTHH:mm:ssZ" ) をサポートします。.. 開始日または終了日を省略します。
embeddable いいえ 文字列の配列 - 機能を埋め込むことでビデオをフィルター処理します。 使用できる値: "player" (埋め込み可能なプレーヤーを含む)。 設定しない場合、フィルター処理は適用されません。
解像度 いいえ 文字列 - 最小解像度でビデオをフィルター処理します。 値: "360p"、"480p"、"720p"、"1080p"。 設定しない場合、フィルター処理は適用されません。
safeSearch いいえ 文字列 "strict" 安全な検索フィルター処理のレベル。 値: "off"、"strict"。 既定値は "strict" です。
duration いいえ 文字列 - ビデオを期間の範囲でフィルター処理します。 値: "short" (<5 分)、"medium" (5 ~ 20 分)、"long" (>20 分)。 設定しない場合、フィルター処理は適用されません。

要求ヘッダー

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

応答

ビデオ応答

Field タイプ Description
videoResults videoResult の配列 ビデオ結果の一覧。
プレイリスト playlistResult の配列 (省略可能) プレイリストの結果の一覧。
instrumentationClickBase 文字列 クリック ping 要求のベース URL。 結果項目から instrumentationSuffix 値を追加して、完全な ping URL を形成します。 EnableInstrumentationPing プロファイル フラグを持つアプリケーションにのみ存在します。 注: ユーザーのクリックは、URL リダイレクトを使用してログに記録することもできます。 リダイレクトが有効になっている場合、ユーザーのクリックをログに記録するためのアクションは必要なく、 instrumentationClickBase は応答に含まれません。 セットアップ手順については、 インストルメンテーション ガイド を参照してください。
instrumentationCitationBase 文字列 LLM ログ ping 要求のベース URL。 完全な ping URL を形成する DATA ペイロードを追加します。 EnableInstrumentationPing プロファイル フラグを持つアプリケーションにのみ存在します。
traceId 文字列 デバッグ用のトレース ID。

Note

playlists は、 enablePlaylist が true に設定されている場合でも省略可能なフィールドです。

videoResult

Field タイプ Description
title 文字列 ビデオのタイトルまたは名前。
url 文字列 ビデオのソース URL。 URL リダイレクトが有効になっている中国のユーザーの場合、このフィールドには clickUrlと同じリダイレクト URL が代わりに含まれます。
ドメイン 文字列 結果の宛先ホスト。 URL リダイレクトが有効になっている中国のユーザーに対してのみ返されます。
description 文字列 ビデオ コンテンツの説明。 これは、ビデオ アップローダーによって提供されるか、LLM によって生成されます。
publishedBy 文字列 ビデオのアップローダーまたはパブリッシャー。
viewCount long ビデオに表示されるビューの数。
概要 文字列 AI によって生成されたビデオの概要。
length 文字列 HH:MM:SS 形式のビデオの長さ。
allowHttpsEmbedding boolean HTTPS 埋め込みを許可するかどうか。
allowMobileEmbedding boolean モバイル埋め込みを許可するかどうか。
embeddingUrl 文字列 ビデオを埋め込むための URL。
lastUpdatedAt 文字列 書式設定された文字列として最後に更新された日付。
bestMomentIndex 整数 ビデオの中で最も良い瞬間またはハイライトのインデックス。
瞬間 瞬間の配列 ビデオ セグメント/瞬間の配列。
サムネイルURL 文字列 ビデオのサムネイル URL。
幅 整数 ビデオの幅 (ピクセル単位)。
height 整数 ビデオの高さ (ピクセル単位)。
isAdult boolean 結果に成人コンテンツが含まれるかどうかを示します。
clickUrl 文字列 クリックをプロキシするリダイレクト URL Bing。 クリック リダイレクトが有効な場合にのみ存在します。
instrumentationSuffix 文字列 この結果項目のインストルメンテーション ping URL ベースに追加するサフィックス。 インストルメンテーション ping URL と clickUrl リダイレクトの両方の K 値として使用されます。 インストルメンテーション ping が有効な場合に表示されます。

Note

上記のいくつかのフィールドは省略可能です。使用可能な場合は提供されます。

moment

Field タイプ Description
title 文字列 モーメント セグメントのタイトル。
description 文字列 この瞬間に何が起こるかについて説明します。
startTime 文字列 "d.hh:mm:ss" 形式の瞬間の開始時刻。
endTime 文字列 "d.hh:mm:ss" 形式の瞬間の終了時刻。
momentUrl 文字列 ビデオ内のこの特定の瞬間への直接 URL。

Note

moment は省略可能な応答オブジェクトです。 すべてのビデオ結果で使用できるわけではありません。

playlistResult

Field タイプ Description
title 文字列 プレイリストのタイトル。
description 文字列 プレイリストの説明。
ビデオ ビデオの配列 プレイリスト内のビデオの配列。

Note

playlistResult は省略可能な応答オブジェクトです。

ビデオ

Field タイプ Description
title 文字列 ビデオのタイトル。
description 文字列 ビデオの説明。
url 文字列 ビデオの URL。

エラー コード

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

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

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

  • 最終更新: