ビデオアセット分析のリクエスト

Prev Next

VPC環境で利用できます。

ビデオアセットを分析し、ビデオ分析結果であるインデックスを作成します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v1/workspaces/{workspace_name}/projects/{project_id}/video-assets/{video_asset_id}/analyze

リクエストヘッダ

Media Intelligence APIで共通して使用されるヘッダの詳細は、Media Intelligenceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
workspace_name String Required ワークスペース名
project_id String Required プロジェクト ID
video_asset_id String Required ビデオアセット ID

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
sceneRange String Optional 自動で分割されるシーンの長さ
  • EXTRA_SHORT | SHORT | MEDIUM (デフォルト) | LONG
    • EXTRA_SHORT(非常に短く): 10~20秒
    • SHORT(短く): 秒単位で細かく分割してビデオ内の詳細なシーンを精密分析
    • MEDIUM(通常): シーン間の適切な流れを維持しながら、主要な変化を捉える
    • LONG(長く): シーン間の連続性を高め、自然な流れを維持
analysisPersonCount Integer Required ビデオの分析時に検出する人物の数
  • 0~10
  • 0を入力すると人物を分析せず、分析スピードが上がる
tagIdList Array<String> Optional ビデオ分析時に検出する人物のタブ
  • 長さ: 1~30
sourceLanguage enum Optional 分析対象ソースビデオの言語情報
  • ENKO (デフォルト) | EN | KO | JA | ZH-CN | ZH-TW
    • ENKO: 韓国語 + 英語
    • EN: 英語
    • KO: 韓国語
    • JA: 日本語
    • ZH-CN: 中国語 (簡体字)
    • ZH-TW: 中国語 (繁体字)
detectAudioEffects Boolean Optional 音声効果を検出するか
  • true | false (デフォルト)
    • 有効化すると「拍手」、「笑い声」、「BGM」項目を検出

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/video-assets/5678/analyze' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
   "sceneRange" : "LONG",
   "sourceLanguage": "ENKO",
   "detectAudioEffects": false,   
   "analysisPersonCount" : 3,
   "tagIdList": [101, 203, 307]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code String Required API処理結果コード
message String Required API処理結果メッセージ
result Object Required 分析結果
result.id Integer Required ビデオアセット ID
result.createdTime String Required インデックスの作成日時
  • ISO 8601形式
result.createdUserName String Required インデックスを作成したユーザー名

レスポンスステータスコード

Media Intelligence APIで共通して使用されるレスポンスステータスコードの詳細は、Media Intelligenceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": "0",
    "message": "success",
    "result": {
        "id": 1001,
        "createdTime": "2025-04-23T17:13:48",
        "createdUserName": "username"
    }
}