Media AI Understanding overview

Prev Next

Available in VPC

Media AI Understanding service is a NAVER Cloud Platform service that automates video analysis that was previously done manually. The Media AI Understanding service provides APIs for project management, video asset management and analysis, and index management in the RESTful form.

Common Media AI Understanding settings

The following describes commonly used request and response formats in Media AI Understanding APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://maiu.apigw.ntruss.com

Request headers

The following describes the request headers.

Field Required Description
x-ncp-apigw-timestamp Required This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
  • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes.
    		•
    x-ncp-iam-access-key Required Access key issued on NAVER Cloud Platform
  • Issue and check access key: See Create authentication key.
  • Issue and check access key for sub account: See Create sub account.
    		•
    x-ncp-apigw-signature-v2 Required Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
  • Issue and check secret key: See Create authentication key.
  • Create signature: See Create signature.
    		•
    Content-type Required Request data format
  • application/json
    		•

    Response

    The following describes the common response format.

    Response body

    The response body includes the following data:

    responseError
    responseError defines the API call failure information. The following describes responseError.

    Field Type Required Description
    code String Required Errors
    message String Required Error message

    Response status codes

    The following describes the response status codes.

    HTTP status code Code Message Description
    200 0 success Request processing successful
    400 10001 Invalid Request. Request parameter error
    400 10014 Select the video you want to analyze. No video to analyze
    400 10016 Select the bucket to integrate (folder selection not available). Directory items can't be registered.
    400 10023 You can request up to 10 videos at a time. The maximum number of videos that can be registered is exceeded (10).
    400 10027 The base project name can't be changed. The default project can't be changed.
    400 10033 The base project can't be deleted. The default project can't be deleted.
    400 10041 The bucket integration is invalid. Check the bucket information again in the NAVER Cloud Platform console. Invalid bucket in NAVER Cloud Platform console
    400 10046 Failed to set object storage ACL. Invalid bucket in NAVER Cloud Platform console
    400 10048 Check the linked Object Storage settings The Object Storage file doesn't exist.
    400 50003 Analyze result not exists. Directory items can't be registered.
    401 10003 Failed to check permissions. Permission check failure
    404 10010 The video file does not exist. No video file
    404 10025 The project does not exist. No project
    404 10030 The workspace does not exist. No workspace
    404 10038 Unanalyzed videos can't be canceled. Unable to cancel unanalyzed video
    404 40002 The video analysis job does not exist. No video analysis job
    409 10026 This project name already exists. Duplicate project name
    409 10045 Can create up to 1,000 items per workspace. The maximum number of projects you can create in a workspace is exceeded.
    409 10049 The project name exceeds the maximum length(100). Project name length exceeded
    409 20012 Exist Workspace Name. Duplicate workspace name
    422 10017 Analyzing video. Analyzing video
    500 99999 An error has occurred. Internal server error
    Note

    For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

    Response example

    For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

    {
    "code": "10001",
    "message": "Invalid request."
}

    Media AI Understanding API

    The following describes the APIs provided by the Media AI Understanding service.

    Manage Project

    API Description
    Create project Create a project, a place to manage video assets and analytics results.
    Get project list Get the list of projects in a workspace.
    Get project details Get details of projects in a workspace.
    Edit project information Edit project information in a workspace.
    Delete project Delete project from a workspace.

    Manage video asset

    API Description
    Register video asset Add a video file uploaded to an Object Storage bucket to a project.
    Get video asset list Get the list of video assets in a project.
    Get video asset details Get details of video assets in a project.
    Get video asset registration status Get the status of a video asset registered in a project.
    Move video asset project Move a video asset to another project.
    Delete video asset Delete a video asset from a project.

    Analyze video asset

    API Description
    Request video asset analysis Analyze a video asset to create an index, which is the result of video analysis.
    Get video asset analysis status Get the analysis status of a video asset registered in a project.
    Cancel video asset analysis Cancel analysis request for a video asset in progress.

    Manage index

    API Description
    Get index list Get the index list of a video asset.
    Get index details Get details of indices for a video asset.
    Delete index Delete an index of a video asset.

    Media AI Understanding related resources

    NAVER Cloud Platform provides a variety of related resources to help users better understand Media AI Understanding APIs.