The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.
Available in VPC
Issue a presigned URL for uploading images to be utilized for searching.
- The issued presigned URL is valid for 15 minutes and is a one-time use.
- Only one image file can be uploaded at a time.
- File specifications are as follows:
- Format:
jpg,png,webp,heic - Maximum size: 5 MB
- Minimum resolution: 224px or higher
- Format:
- Call limit: 50 calls per second
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| POST | /api/v1/query-assets/uploads/presigned-url |
Request headers
For information about the headers common to all Media Intelligence APIs, see Media Intelligence request headers.
Request body
You can include the following data in the body of your request:
| Field | Type | Required | Description |
|---|---|---|---|
assetType |
String | Required | Asset type
|
assetFileName |
String | Required | Name of image file to upload
|
Request example
The request example is as follows:
curl --location --request POST 'https://maiu.apigw.ntruss.com/api/v1/query-assets/uploads/presigned-url' \
--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 '{
"assetType": "IMAGE",
"assetFileName": "search_image.png"
}'
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 | Presigned URL issuance result object |
result.assetFileKey |
String | Required | Path to the image file to be stored in Object Storage |
result.presignedUploadUrl |
String | Required | Presigned URL address for upload
|
result.expirationSeconds |
Integer | Required | URL's validity time (unit: second)
|
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": {
"assetFileKey": "images/.../abc.jpg",
"presignedUploadUrl": "https://kr.object.ncloudstorage.com/.../abc.jpg?...",
"expirationSeconds": 900
}
}