Get person thumbnail upload status

Prev Next

Available in VPC

After uploading a person thumbnail image via the presigned URL, check the upload completion status of the image.

Note

Up to 1000 calls can be made per minute.

Request

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

Method URI
POST /api/v1/workspaces/{workspace_name}/person-thumbnail/uploads/complete

Request headers

For information about the headers common to all Media Intelligence APIs, see Media Intelligence request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
workspace_name String Required Workspace name

Request body

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

Field Type Required Description
thumbnailKey String Required Key value of the image file to check for upload completion

Request example

The request example is as follows:

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/person-thumbnail/complete' \
--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 '{
  "thumbnailKey": "persons/thumbnails/test_profile.jpg"
}'

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 Upload status result
result.uploadStatus String Required Upload status
  • COMPLETED | FAILED
    • COMPLETED: Thumbnail image upload completed successfully.
    • FAILED: Thumbnail image upload failed, reason for failure can be found in uploadMessage field.
result.uploadMessage String Optional Reason for upload failure
  • FILE_NOT_EXIST: Uploaded file can't be found
  • OVER_SIZE_LIMIT: File size exceeds 5 MB.
  • RESOLUTION_NOT_SUPPORT: Image resolution does not meet minimum requirements (256px or higher).
  • CAN_NOT_GET_IMAGE_INFO: Failed to load image metadata.
  • IMAGE_CAN_NOT_BE_PREDICTED: Face image can't be found.
  • IMAGE_FORMAT_NOT_SUPPORT: Unsupported image format (other than JPG, PNG, WEBP)
  • IMAGE_CROP_ERROR: Error during cropping operation (image extraction failure based on 256px)

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": {
    "uploadStatus": "COMPLETED",
    "uploadMessage": null
  }
}