Get index details

Available in VPC

Get details of indices for a media asset.

Request

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	-	Media asset ID
`result.type`	String	-	Asset type `IMAGE` \| `VIDEO` `IMAGE`: Image `VIDEO`: 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 `Sinossi v1.0`
`result.analysisSetting.sceneRange`	String	-	(During video analysis) 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. Image assets are displayed as null.
`result.analysisSetting.analysisPersonCount`	Integer	-	Number of people to detect when analyzing
`result.analysisSetting.analysisLanguage`	String	-	Reference language for video analysis This field will be removed in the future (replacement field: `sourceLanguage`).
`result.analysisSetting.sourceLanguage`	String	-	Language information of the original video being analyzed `ENKO` (default) \| `EN` \| `KO` \| `JA` \| `ZH-CN` \| `ZH-TW` `ENKO`: Korean + English `EN`: English `KO`: Korean `JA`: Japanese `ZH-CN`: Chinese (Simplified) `ZH-TW`: Chinese (Traditional)
`result.analysisSetting.detectAudioEffects`	Boolean	-	(During video analysis) Whether to add the audio effect set during analysis `true`│`false` (default) `true`: Add keywords for detected audio effects when enabled.
`result.indexDetails`	Object	-	Index content information
`result.indexDetails.durationMs`	Integer	-	(During video analysis) Video length (millisecond) Image assets are displayed as 0.
`result.indexDetails.fps`	Integer	-	(During video analysis) Number of frames per second Image assets are displayed as 0.
`result.indexDetails.frameCount`	Integer	-	(During video analysis) Total frame count Image assets are displayed as 0.
`result.indexDetails.assetUrl`	String	-	Media asset original URL
`result.indexDetails.segments`	Array	-	Segment list: segments

`segments`

The following describes segments.

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

`speeches`

The following describes speeches.

Field	Type	Required	Description
`id`	Integer	-	Utterance ID
`startMs`	Integer	-	Utterance start time (millisecond)
`endMs`	Integer	-	Utterance end time (millisecond)
`text`	String	-	Utterance content
`pid`	String	-	Person ID
`name`	String	-	Person name

`keywords`

The following describes keywords.

Field	Type	Required	Description
`category`	String	-	Keyword category
`group`	String	-	Keyword group
`text`	String	-	Keyword text
`score`	Integer	-	Keyword confidence score

`people`

The following describes people.

Field	Type	Required	Description
`name`	String	-	Person name
`pid`	String	-	Person ID
`img`	String	-	Image URL

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": {
        "indexId": 1001,
        "type": "VIDEO",
        "createdTime": "2025-04-24T16:42:00",
        "createdUserName": "username",
        "updatedTime": "2025-04-24T16:43:08",
        "updatedUserName": "username",
        "analysisSetting": {
            "analysisEngine": "Sinossi v1.0",
            "sceneRange": "MEDIUM",
            "analysisPersonCount": 2,
            "analysisLanguage": "ENKO"
            "sourceLanguage": "ENKO",
            "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
                        },
                        {
                            "category": "Video production technique",
                            "group": "Shooting technique",
                            "text": "Interview",
                            "score": 85.12
                        }
                    ],
                    "people": []
                },
                {
                    "start": 275,
                    "end": 467,
                    "startMs": 9176,
                    "endMs": 15583,
                    "scene": 2,
                    "shot": 2,
                    "sceneThumbnailUrl": "https://kr.object.ncloudstorage.com/.../1234/2.jpg?X-Amz-..."
                    "speeches": [
                        {
                            "id": 180081,
                            "startMs": 10195,
                            "endMs": 20000,
                            "text": "Thank you for inviting me in. It's a pleasure to meet you."
                            "pid": "2",
                            "name": "Speaker 2"
                        }
                    ],
                    "keywords": [
                        {
                            "category": "Location",
                            "group": "Commercial facility",
                            "text": "Broadcast studio",
                            "score": 80.26
                        }
                    ],
                    "people": [
                        {
                            "name": "Person 2",
                            "pid": "9876543210987654321",
                            "img": "https://kr.object.ncloudstorage.com/maiu-my-storage/indexer/1001/people/9876543210987654321.jpg?"
                        }
                    ]
                },
                {
                    "start": 467,
                    "end": 601,
                    "startMs": 15583,
                    "endMs": 20054,
                    "scene": 2,
                    "shot": 3,
                    "sceneThumbnailUrl": "https://kr.object.ncloudstorage.com/.../12345/2.jpg?X-Amz-..."
                    "speeches": [],
                    "keywords": [
                        {
                            "category": "Object",
                            "group": "Fashion",
                            "text": "Wristwatch",
                            "score": 85.81
                        }
                    ],
                    "people": [
                        {
                            "name": "Person 1",
                            "pid": "1234567890123456789",
                            "img": "https://kr.object.ncloudstorage.com/maiu-my-storage/indexer/1001/people/1234567890123456789.jpg"
                        }
                    ]
                }
            ]
        }
    }
}