Get video asset list

Prev Next

Available in VPC

Get the list of video assets in a project.

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

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

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
pageNum Integer Required Page number
  • 1 or more
pageSize Integer Optional Number of items per page
  • 1-1000 (default: 1000)

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?pageNum=1&pageSize=100' \
--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 Object Required API return information
result.content Array Required Video asset list
result.totalCount Integer Required Total video asset count
result.totalPage Integer Required Total number of pages
result.pageNo Integer Required Page number
result.pageSize Integer Required Number of items per page

result.content

Field Type Required Description
videoId Integer Required Video asset ID
videoName String Required Video file name
projectId Integer Required Project ID
metaData Object Required Video metadata details
metaData.resolution String Required Video resolution
  • Example: 1920x1080
metaData.durationMs Integer Required Video length (millisecond)
metaData.size Integer Required Video file size (byte)
metaData.format String Required Video file format
  • mp4 | mkv | mov | webm
key String Required Full file name of the video uploaded to Object Storage
createUserName String Required User name that registered the video asset
createdTime String Required Video asset registration date and time
  • ISO 8601 format
updateUserName String Required User name who last edited the video asset
updatedTime String Required Video asset last modification date and time
  • ISO 8601 format

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": {
        "content": [
            {
                "videoId": 1001,
                "videoName": "sample-video-one.mp4",
                "projectId": 1234,
                "metaData": {
                    "resolution": "1280x720",
                    "durationMs": 91565,
                    "size": 101176289,
                    "format": "mp4"
                },
                "key": "sample-video-one.mp4",
                "createUserName": "user1",
                "createdTime": "2025-04-23T16:49:24",
                "updateUserName": "user1",
                "updatedTime": "2025-04-23T16:49:25"
            },
            {
                "videoId": 1002,
                "videoName": "sample-video-two.mp4",
                "projectId": 1234,
                "metaData": {
                    "resolution": "1920x1080",
                    "durationMs": 253702,
                    "size": 120333399,
                    "format": "mp4"
                },
                "key": "sample-video-two.mp4",
                "createUserName": "user2",
                "createdTime": "2025-04-23T17:13:37",
                "updateUserName": "user2",
                "updatedTime": "2025-04-23T17:13:38"
            },
            {
                "videoId": 1003,
                "videoName": "sample-video-three.mp4",
                "projectId": 1234,
                "metaData": {
                    "resolution": "1920x1080",
                    "durationMs": 293849,
                    "size": 76597066,
                    "format": "mp4"
                },
                "key": "sample-video-three.mp4",
                "createUserName": "user3",
                "createdTime": "2025-04-23T17:13:48",
                "updateUserName": "user3",
                "updatedTime": "2025-04-23T17:13:49"
            }
        ],
        "totalCount": 3,
        "totalPage": 1,
        "pageNo": 1,
        "pageSize": 100
    }
}