Get index list

Prev Next

Available in VPC

Get the index list of a video asset.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/workspaces/{workspace_name}/projects/{project_id}/video-assets/{video_asset_id}/indexes

Request headers

For information about the headers common to all Media Intelligence APIs, see Media Intelligence request headers.

Request path parameters

The following describes the parameters.

Field Type Required Description
workspace_name String Required Workspace name
project_id String Required Project ID
video_asset_id String Required Video asset ID

Request example

The request example is as follows:

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

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
code String Required API processing result code
message String Required API processing result message
result.totalCount Integer Required Total index count
result.indexes Array Required Index object list

result.indexes

Field Type Required Description
indexId Integer Required Index ID
createdTime String Required Index creation date and time
  • ISO 8601 format
createdUserName String Required User name that created the index
updatedTime String Required Last index modification date and time
  • ISO 8601 format
updatedUserName String Required User name who last edited the index
analysisSetting Object Required Analysis configuration information
analysisSetting.analysisEngine String Required Analysis engine version
  • Sinossi v1.0
analysisSetting.sceneRange String Required Length of automatically split scenes
  • SHORT | MEDIUM (default) | LONG
    • SHORT: Analyze detailed scenes in the video with second-by-second segmentation.
    • MEDIUM: Capture key changes while maintaining proper flow between scenes.
    • LONG: Maintain a natural flow by enhancing connectivity between scenes.
analysisSetting.analysisPersonCount Integer Required Number of people to detect when analyzing video
analysisSetting.analysisLanguage String Required Reference language for video analysis
  • This field will be removed in the future (replacement field: sourceLanguage).
analysisSetting.sourceLanguage String Required
result.analysisSetting.detectAudioEffects Boolean Required Whether to add the audio effect set during analysis of the video
  • true│false (default)

Response status codes

For information about the HTTP status codes common to all Media Intelligence APIs, see Media Intelligence response status codes.

Response example

The response example is as follows:

{
    "code": "0",
    "message": "success",
    "result": {
        "totalCount": 2,
        "indexes": [
            {
                "indexId": 1001,
                "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,
                "createdTime": "2025-04-24T10:31:08",
                "createdUserName": "username",
                "updatedTime": "2025-04-24T10:33:11",
                "updatedUserName": "username",
                "analysisSetting": {
                    "analysisEngine": "Sinossi v1.0",
                    "sceneRange": "MEDIUM",
                    "analysisPersonCount": 8,
                    "analysisLanguage": "EN"
                    "sourceLanguage": "EN",
                    "detectAudioEffects": false                  
                }
            }
        ]
    }
}