Get index details (deprecated)

Available in VPC

Caution

This API is deprecated and is scheduled to be removed in January 2027. Use the new Get index API to retrieve the latest index entry for each asset.

Get details of indices for a media 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}/assets/{asset_id}/indexes/{index_id}

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`workspace_name`	String	Required	Workspace name
`project_id`	String	Required	Project ID See Get project list.
`asset_id`	String	Required	Media asset ID See Get media asset list.
`index_id`	String	Required	Index ID See Get index list.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`confidence_level`	String	Optional	Filtering criteria based on confidence `LOW` \| `MEDIUM` (default) \| `HIGH` `LOW`: Display low confidence detection results (extract more keywords). `MEDIUM`: Display medium confidence detection results (moderate keyword extraction). `HIGH`: Display high confidence detection results (accurate keyword extraction).

Request example

The request example is as follows:

curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/assets/5678/indexes/1001?confidence_level=MEDIUM' \
--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	-	API processing result code
`message`	String	-	API processing result message
`result`	Object	-	Analysis result
`result.indexId`	Integer	-	Index ID
`result.type`	String	-	Asset type `IMAGE` \| `VIDEO`
`result.createdTime`	String	-	Index creation date and time ISO 8601 format
`result.createdUserName`	String	-	User name that created the index
`result.updatedTime`	String	-	Last index modification date and time ISO 8601 format
`result.updatedUserName`	String	-	User name who last edited the index
`result.analysisSetting`	Object	-	Analysis configuration information
`result.analysisSetting.analysisEngine`	String	-	Analysis engine version Example: `v3.2`
`result.analysisSetting.sceneRange`	String	Optional	(During video analysis) Length of automatically split scenes `SHORT` \| `MEDIUM` (default) \| `LONG` Image assets are displayed as null. Displayed as null if analyzed with `minSceneDurationSec`/`maxSceneDurationSec`.
`result.analysisSetting.minSceneDurationSec`	Integer	Optional	(During video analysis) Minimum scene duration set during the analysis request (second) Displayed as null if analyzed using `sceneRange`. Image assets are displayed as null.
`result.analysisSetting.maxSceneDurationSec`	Integer	Optional	(During video analysis) Maximum scene duration set during the analysis request (second) Displayed as null if analyzed using `sceneRange`. Image assets are displayed as null.
`result.analysisSetting.analysisPersonCount`	Integer	-	Number of people to detect when analyzing
`result.analysisSetting.sourceLanguage`	String	-	Language information for the source video being analyzed `KO` (default) \| `ENKO` \| `EN` \| `JA` \| `ZH-CN` \| `ZH-TW`
`result.analysisSetting.detectAudioEffects`	Boolean	Optional	(During video analysis) Whether to add the audio effect set during analysis of the video `true` \| `false` (default)
`result.indexDetails`	Object	-	Index content information
`result.indexDetails.durationMs`	Integer	Optional	(During video analysis) Video length (millisecond) Image assets are displayed as 0.
`result.indexDetails.fps`	Integer	Optional	(During video analysis) Number of frames per second Image assets are displayed as 0.
`result.indexDetails.frameCount`	Integer	Optional	(During video analysis) Total frame count Image assets are displayed as 0.
`result.indexDetails.assetUrl`	String	-	Media asset source URL
`result.indexDetails.segments`	Array	-	Segment list

result.indexDetails.segments

Field	Type	Required	Description
`start`	Integer	Optional	(During video analysis) Segment start frame number. 0 for image assets.
`end`	Integer	Optional	(During video analysis) Segment end frame number. 0 for image assets.
`startMs`	Integer	Optional	(During video analysis) Segment start time (millisecond). 0 for image assets.
`endMs`	Integer	Optional	(During video analysis) Segment end time (millisecond). 0 for image assets.
`scene`	Integer	Optional	(During video analysis) Scene number. 0 for image assets.
`shot`	Integer	Optional	(During video analysis) Shot number. 0 for image assets.
`sceneThumbnailUrl`	String	Optional	(During video analysis) Thumbnail image URL (valid for 1 hour)
`speeches`	Array	Optional	Utterance information
`keywords`	Array	-	Keyword information
`people`	Array	-	Character information

Response status codes

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

Response example

Index analyzed using a preset

{
    "code": "0",
    "message": "success",
    "result": {
        "indexId": 1001,
        "type": "VIDEO",
        "createdTime": "2025-04-24T16:42:00",
        "createdUserName": "username",
        "updatedTime": "2025-04-24T16:43:08",
        "updatedUserName": "username",
        "analysisSetting": {
            "analysisEngine": "v3.2",
            "sceneRange": "MEDIUM",
            "minSceneDurationSec": null,
            "maxSceneDurationSec": null,
            "analysisPersonCount": 2,
            "sourceLanguage": "KO",
            "detectAudioEffects": true
        },
        "indexDetails": {
            "durationMs": 20054,
            "fps": 29.97,
            "frameCount": 601,
            "assetUrl": "https://kr.object.ncloudstorage.com/maiu-my-storage/videos/1234/interview.mp4",
            "segments": [
                {
                    "start": 0,
                    "end": 275,
                    "startMs": 0,
                    "endMs": 9176,
                    "scene": 1,
                    "shot": 1,
                    "sceneThumbnailUrl": "https://kr.object.ncloudstorage.com/.../1234/1.jpg?X-Amz-...",
                    "speeches": [
                        {
                            "id": 180080,
                            "startMs": 679,
                            "endMs": 10195,
                            "text": "Hello, thank you for joining us today for this interview.",
                            "pid": "1",
                            "name": "Speaker 1"
                        }
                    ],
                    "keywords": [
                        {
                            "category": "Behavior",
                            "group": "Business, office, event",
                            "text": "News anchor",
                            "score": 87.23
                        }
                    ],
                    "people": []
                }
            ]
        }
    }
}

Index analyzed by specifying scene length manually

{
    "code": "0",
    "message": "success",
    "result": {
        "indexId": 1002,
        "type": "VIDEO",
        "createdTime": "2025-04-24T16:42:00",
        "createdUserName": "username",
        "updatedTime": "2025-04-24T16:43:08",
        "updatedUserName": "username",
        "analysisSetting": {
            "analysisEngine": "v3.2",
            "sceneRange": null,
            "minSceneDurationSec": 15,
            "maxSceneDurationSec": 60,
            "analysisPersonCount": 2,
            "sourceLanguage": "KO",
            "detectAudioEffects": false
        },
        "indexDetails": {
            "durationMs": 20054,
            "fps": 29.97,
            "frameCount": 601,
            "assetUrl": "https://kr.object.ncloudstorage.com/maiu-my-storage/videos/1234/interview.mp4",
            "segments": []
        }
    }
}

Documentation Index