Available in VPC
Media Intelligence is a media AI analysis service on NAVER Cloud Platform that automates media (video, photo) analysis previously done manually. The Media Intelligence service provides APIs for project management, media asset management and analysis, and index management in the RESTful form.
Common Media Intelligence settings
The following describes commonly used request and response formats in Media Intelligence APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
https://mi.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.
|
x-ncp-iam-access-key |
Required | Access key issued on NAVER Cloud Platform
|
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)
|
Content-type |
Required | Request data format
|
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.
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 asset you want to analyze. | No media to analyze |
| 400 | 10016 | Select the bucket to integrate (folder selection not available). | Folder items can't be registered. |
| 400 | 10023 | You can request up to 10 assets at a time. | The number of media available for registration has been exceeded (maximum 10). |
| 400 | 10027 | The base project name can't be changed. | The base project name can't be changed. |
| 400 | 10033 | The base project can't be deleted. | The base project can't be deleted. |
| 400 | 10041 | The bucket integration is invalid. Check the bucket information again in the NAVER Cloud Platform console. | Bucket information is invalid (verification required in the console). |
| 400 | 10046 | Failed to set object storage ACL. | Object Storage ACL setting failed. |
| 400 | 10048 | Check the linked Object Storage settings | The Object Storage file doesn't exist. |
| 400 | 50003 | Analyze result not exists. | Analysis results do not exist. |
| 400 | 50010 | Either projectIds or assetIds should be provided, not both. | Only one of either projectIds or assetIds should be provided. |
| 400 | 50011 | Either imageQuery or textQuery should be provided, not both. | Only one of either imageQuery or textQuery should be provided. |
| 400 | 50012 | Person query limit reached. You can only pass a maximum of 100 personIds at a time. | A maximum of 100 person IDs can be transmitted at a time. |
| 400 | 50013 | Script query limit reached. You can only pass a maximum of 100 scripts at a time. | A maximum of 100 dialogues can be transmitted at a time. |
| 400 | 10069 | Please upload a large, clear image of your face, looking straight ahead. | Upload a high-resolution face image facing forward. |
| 400 | 10072 | Invalid file format. | Invalid file format |
| 400 | 10073 | Image crop error. | Image crop error |
| 400 | 10074 | Image cover upload failed. | Image cover upload failed. |
| 400 | 10075 | Representative thumbnail not exist. | No representative thumbnail exists. |
| 400 | 10077 | Can not delete all thumbnails. | All thumbnails can't be deleted. |
| 401 | 10003 | Failed to check permissions. | Permission check failure |
| 404 | 10010 | The asset file does not exist. | The media file does not exist. |
| 404 | 10025 | The project does not exist. | The project does not exist. |
| 404 | 10030 | The workspace does not exist. | The workspace does not exist. |
| 404 | 10038 | Unanalyzed assets can't be canceled. | Unanalyzed assets can't be canceled. |
| 404 | 40002 | The asset analysis job does not exist. | The media asset analysis job does not exist. |
| 409 | 10026 | This project name already exists. | The project name already exists. |
| 409 | 10045 | Can create up to 1,000 items per workspace. | The maximum number of items that can be created per workspace (1000) has been exceeded. |
| 409 | 10049 | The project name exceeds the maximum length(100). | The project name exceeds the maximum length (100 characters). |
| 409 | 20012 | Exist Workspace Name. | A workspace with the same name already exists. |
| 409 | 10062 | Tag already registered. | The tag has already been registered. |
| 409 | 10068 | You can register up to 500 items. | The maximum number of registrations (500) has been exceeded. |
| 409 | 10076 | Primary thumbnail exceeded the limit. | The maximum number of representative thumbnails has been exceeded. |
| 409 | 50005 | The name is already in use. Please enter a different name. | This name is already in use. Enter another name. |
| 422 | 10017 | Analyzing asset. | Analyzing media asset |
| 422 | 10072 | Invalid file format. | Invalid file format |
| 500 | 99999 | An error has occurred. | Internal server error |
Note
For information about the HTTP status codes common to all 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 Intelligence API
The following describes the APIs provided by the Media Intelligence service.
Project management
| API | Description |
|---|---|
| Create project | Create a project, a place to manage media 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 media asset
| API | Description |
|---|---|
| Register media asset | Add a file uploaded to an Object Storage bucket to a project. |
| Get media asset list | Get the list of media assets in a project. |
| Get media asset details | Get details of media assets in a project. |
| Get media asset registration status | Get the status of a media asset registered in a project. |
| Move media asset project | Move a media asset to another project. |
| Delete media asset | Delete a media asset from a project. |
Analyze media asset
| API | Description |
|---|---|
| Request media asset analysis | Analyze a media asset to create an index, which is the result of analysis. |
| Get media asset analysis status | Get the analysis status of a media asset registered in a project. |
| Cancel media asset analysis | Cancel analysis request for a media asset in progress. |
Manage index
| API | Description |
|---|---|
| Get index list | Get the index list of a media asset. |
| Get index details | Get details of indices for a media asset. |
| Delete index | Delete an index of a media asset. |
Manage person tag
| API | Description |
|---|---|
| Register person tag | Register a person tag in a workspace. |
| Get person tag list | Get a list of person tags in a workspace. |
| Delete person tag | Delete a person tag from a workspace. |
People management
| API | Description |
|---|---|
| Register person | Register a new person in a workspace. |
| Get person details | Get person details. |
| Edit person information | Edit information such as person name, description, etc. |
| Set person modification tag | Set a tag to a person. |
| Remove person modification tag | Remove a tag from a person. |
| Set person modification thumbnail | Set a person thumbnail. |
| Remove person modification thumbnail | Remove a person thumbnail. |
| Delete person | Delete a person from a workspace. |
| Get people list | Get the people list in a workspace. |
| Issue thumbnail presigned URL | Issue a presigned URL for person thumbnail upload. |
| Get thumbnail upload status | Get thumbnail upload complete status. |
Scene search
| API | Description |
|---|---|
| Issue search asset presigned URL | Issue a query asset upload presigned URL for scene search. |
| Get search asset upload status | Check the upload completion status of an uploaded query asset. |
| Request asset search | Search for scenes and images that meet the specified conditions for the media asset. |
| Get asset search result | Get results for scene search requests (scene and image list). |
Media Intelligence related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand Media Intelligence APIs.
-
Media Intelligence API guides
- Create signature: How to create a signature to add to the request header
- API Gateway user guide: How to issue the API key to be added to the request header
- Sub Account User Guides: How to issue the access key to be added to the request header
- Common Ncloud response status codes: Information on common response status codes of NAVER Cloud Platform used by the Media Intelligence service
-
Media Intelligence service guides
- Media Intelligence user guide: How to use Media Intelligence from the NAVER Cloud Platform console
- Ncloud user environment guide: Explore VPC and Classic environments and supported services.
- Pricing and features: View pricing details and key capabilities.
- Latest service news: The latest news on Media Intelligence service
- FAQs: Get answers to common Media Intelligence questions.
- Contact Support: Get help if you can't find what you need in the API guide.