Get video asset analysis status

Prev Next

Available in VPC

Get the analysis status of a video asset registered in a project.

Request

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

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
video_asset_id String Required Video asset ID

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/5678/analyze-status' \
--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 Video asset analysis status information
result.status String Required Video analysis status
  • BEFORE_ANALYZE | WAIT_ANALYZE | ANALYZING | ANALYZE_COMPLETED | ANALYZE_FAIL | ANALYZE_CANCEL
    • BEFORE_ANALYZE: Initial status when no video analysis has been performed
    • WAIT_ANALYZE: Job pending after requesting analysis
    • ANALYZING: Analysis in progress
    • ANALYZE_COMPLETED: Analysis succeeded
    • ANALYZE_FAIL: Error occurred while analyzing
    • ANALYZE_CANCEL: Analysis canceled by the user
result.analyzeStatusMessage String Optional Reason for failed video analysis
  • An error occurred during video analysis (video parsing failure).
  • An error occurred during video analysis (person extraction failure).
  • An error occurred during video analysis (keyword encoding failure).
  • An error occurred during video analysis (analysis result processing failure).
result.indexId Integer Optional Index ID created on successful analysis

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": {
        "status": "ANALYZE_COMPLETED",
        "analysisStatusMessage": null,
        "indexId": 1001
    }
}