人物サムネイルアップロード状態の照会

最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

VPC環境で利用できます。

Presigned URLから人物サムネイル画像をアップロードし、その画像のアップロード完了状態を確認します。

参考

呼び出し制限: 1分当たり1,000件

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v1/workspaces/{workspace_name}/person-thumbnail/uploads/complete

リクエストヘッダ

Media AI Understanding API で共通して使用されるヘッダの詳細は、Media AI Understandingのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`workspace_name`	String	Required	ワークスペース名

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`thumbnailKey`	String	Required	アップロードが完了したかどうかを確認する画像ファイルのキー値事前にPresigned URLの発行 APIの呼び出しで発行された`thumbnailKey`を使用

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://maiu.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"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	String	Required	API処理結果コード
`message`	String	Required	API処理結果メッセージ
`result`	Object	Required	アップロード状態の結果
`result.uploadStatus`	String	Required	アップロード状態 `COMPLETED` \| `FAILED` `COMPLETED`: サムネイル画像のアップロードが正常に完了 `FAILED`: サムネイル画像のアップロードは失敗し、失敗の理由は`uploadMessage`フィールドで確認可能
`result.uploadMessage`	String	Optional	アップロード失敗時の理由 `FILE_NOT_EXIST`: アップロードされたファイルが見つからない `OVER_SIZE_LIMIT`: ファイルサイズが5MBを超える `RESOLUTION_NOT_SUPPORT`: 画像の解像度が最小条件(256px以上)を満たさない `CAN_NOT_GET_IMAGE_INFO`: 画像メタデータの読み込みに失敗 `IMAGE_CAN_NOT_BE_PREDICTED`: 顔画像が見つからない `IMAGE_FORMAT_NOT_SUPPORT`: サポートしない画像形式 (jpg、png、webp以外) `IMAGE_CROP_ERROR`: クロップ中にエラー発生 (256px基準画像抽出に失敗)

レスポンスステータスコード

Media AI Understanding APIで共通して使用されるレスポンスステータスコードの詳細は、Media AI Understandingのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "code": "0",
  "message": "success",
  "result": {
    "uploadStatus": "COMPLETED",
    "uploadMessage": null
  }
}