Available in VPC
After uploading an image for search via the presigned URL, check the upload completion status of the image.
Up to 1000 calls can be made per minute. If you need to adjust the call volume, contact Support.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| POST | /api/v1/query-assets/uploads/complete |
Request headers
For information about the headers common to all Media Intelligence APIs, see Media Intelligence request headers.
Request path parameters
There is no request path parameter.
Request body
You can include the following data in the body of your request:
| Field | Type | Required | Description |
|---|---|---|---|
assetKey |
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/query-assets/uploads/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 '{
"assetKey": "images/.../query_image.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
| Field | Type | Required | Description |
|---|---|---|---|
assetKey |
String | Required | Key value of the uploaded image file
|
uploadStatus |
String | Required | Upload status
|
uploadMessage |
String | Optional | Detailed message when upload fails
|
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": {
"assetKey": "images/.../query_image.jpg",
"uploadStatus": "COMPLETED",
"uploadMessage": null
}
}