インデックスリストの照会

VPC環境で利用できます。

メディアアセットのインデックスリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/workspaces/{workspace_name}/projects/{project_id}/assets/{asset_id}/indexes

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`workspace_name`	String	Required	ワークスペース名
`project_id`	String	Required	プロジェクト ID プロジェクトリストの照会を参照
`asset_id`	String	Required	メディアアセット ID メディアアセットリストの照会を参照

リクエスト例

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

curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/assets/5678/indexes' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	String	Required	API処理結果コード
`message`	String	Required	API処理結果メッセージ
`result.totalCount`	Integer	Required	インデックスの総数
`result.indexes`	Array	Required	インデックスオブジェクトリスト

result.indexes

フィールド	タイプ	必須の有無	説明
`indexId`	Integer	Required	インデックス ID
`type`	String	Required	アセットタイプ `IMAGE` \| `VIDEO` `IMAGE`: 画像 `VIDEO`: ビデオ
`createdTime`	String	Required	インデックスの作成日時 ISO 8601形式
`createdUserName`	String	Required	インデックスを作成したユーザー名
`updatedTime`	String	Required	インデックスの最終更新日時 ISO 8601形式
`updatedUserName`	String	Required	インデックスを最後に更新したユーザー名
`analysisSetting`	Object	Required	分析設定情報
`analysisSetting.analysisEngine`	String	Required	分析エンジンバージョン `Sinossi v1.0`
`analysisSetting.sceneRange`	String	Optional	(ビデオ分析時)自動で分割されるシーンの長さ `SHORT` \| `MEDIUM` (デフォルト) \| `LONG` `SHORT`(短く): 短い単位で細かく分割してビデオ内の詳細なシーンを精密分析 `MEDIUM`(通常): シーン間の適切な流れを維持しながら、主要な変化を捉える `LONG`(長く): シーン間の連続性を高め、自然な流れを維持画像アセットは nullと表示
`analysisSetting.analysisPersonCount`	Integer	Required	分析時に検出する人物の数
`analysisSetting.analysisLanguage`	String	Required	分析時の基準となる言語このフィールドは今後削除される予定 (代替フィールド: `sourceLanguage`)
	`analysisSetting.sourceLanguage`	String	Required
`result.analysisSetting.detectAudioEffects`	Boolean	Optional	(ビデオ分析時)分析時に設定した音声効果を追加するかどうか `true`│`false` (デフォルト)

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

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

レスポンス例

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

{
    "code": "0",
    "message": "success",
    "result": {
        "totalCount": 2,
        "indexes": [
            {
                "indexId": 1001,
                "type": "VIDEO",
                "createdTime": "2025-04-24T10:10:47",
                "createdUserName": "username",
                "updatedTime": "2025-04-24T10:12:52",
                "updatedUserName": "username",
                "analysisSetting": {
                    "analysisEngine": "Sinossi v1.0",
                    "sceneRange": "LONG",
                    "analysisPersonCount": 6,
                    "analysisLanguage": "ENKO"
                    "sourceLanguage": "ENKO",
                    "detectAudioEffects": true                    
                }
            },
            {
                "indexId": 1002,
                "type": "IMAGE",
                "createdTime": "2025-04-24T10:31:08",
                "createdUserName": "username",
                "updatedTime": "2025-04-24T10:33:11",
                "updatedUserName": "username",
                "analysisSetting": {
                    "analysisEngine": "Sinossi v1.0",
                    "sceneRange": null,
                    "analysisPersonCount": 8,
                    "analysisLanguage": "EN"
                    "sourceLanguage": "EN",
                    "detectAudioEffects": false                  
                }
            }
        ]
    }
}