人物更新サムネイルの設定

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

VPC環境で利用できます。

人物にサムネイルを追加します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`workspace_name`	String	Required	ワークスペース名
`person_id`	Integer	Required	人物 ID 人物リストの照会を参照

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`thumbnails`	Array	Required	登録するサムネイルリスト
`thumbnails[].thumbnailKey`	String	Required	Object Storageにアップロードされたサムネイルのキー値
`thumbnails[].isPrimaryThumbnail`	Boolean	Required	代表サムネイルかどうか true \| false

リクエスト例

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

curl --location --request POST 'https://maiu.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons/1001/person-thumbnail' \
--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 '{
  "thumbnails": [
    {
      "thumbnailKey": "my-workspace/W05xCokQ1v/jiho0.jpg",
      "isPrimaryThumbnail": true
    }
  ]
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	String	Required	API処理結果コード
`message`	String	Required	API処理結果メッセージ
`result`	Object	Required	人物サムネイルリストオブジェクト

result

フィールド	タイプ	必須の有無	説明
`thumbnailList`	Array	Required	人物に最終的に登録されたサムネイルリスト既存のサムネイル + 新たに追加されたサムネイル
`thumbnailList[].id`	Integer	Required	サムネイル ID
`thumbnailList[].url`	String	Required	サムネイル画像 URL (Presigned URL)
`thumbnailList[].isPrimaryThumbnail`	Boolean	Required	代表サムネイルかどうか true \| false

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

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

レスポンス例

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

{
  "code": "0",
  "message": "success",
  "result": {
    "thumbnailList": [
      {
        "id": 1234,
        "url": "https://kr.object.ncloudstorage.com/.../jiho0.jpg?...",
        "isPrimaryThumbnail": true
      }
    ]
  }
}