Request video asset analysis

Prev Next

Available in VPC

Analyze a video asset to create an index, which is the result of video analysis.

Request

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

Method URI
POST /api/v1/workspaces/{workspace_name}/projects/{project_id}/video-assets/{video_asset_id}/analyze

Request headers

For information about the headers common to all Media AI Understanding APIs, see Media AI Understanding 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 body

You can include the following data in the body of your request:

Field Type Required Description
sceneRange String Optional 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.
analysisPersonCount Integer Optional Number of people to detect when analyzing video
  • 0-10 (default: 6)
  • When 0 is entered, people are not analyzed, which speeds up analysis.

Request example

The request example is as follows:

curl --location --request POST 'https://maiu.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",
   "analysisPersonCount" : 3
}'

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 Object Required Index details
result.id Integer Required Index ID
result.createdTime String Required Index creation date and time
  • ISO 8601 format
result.createdUserName String Required User name that created the index

Response status codes

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

Response example

The response example is as follows:

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