人物の登録

VPC環境で利用できます。

新規の人物を追加します。人物名を入力しない場合、名前なしの匿名人物として登録され、後で人物情報の更新で名前を指定できます。

参考

同一人物が既に登録されているかどうかを確認する場合は、登録前に人物の照合で類似人物を照会してください。

リクエスト

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

メソッド	URI
POST	/api/v1/workspaces/{workspace_name}/persons

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`name`	String	Optional	人物の名前 1~50文字ワークスペース内で重複不可未入力または nullの場合は匿名人物として登録空白文字列または空白のみ含む場合、登録不可
`description`	String	Optional	人物の説明 1~700文字
`thumbnails`	Array	Required	登録するサムネイルリスト最大100個まで登録各項目は`thumbnailKey`と`isPrimaryThumbnail`フィールドを含む代表サムネイルは1つだけ指定
`thumbnails[].thumbnailKey`	String	Required	アップロードされたサムネイルのキー値 <例> `persons/thumbnails/hong.jpg`
`thumbnails[].isPrimaryThumbnail`	Boolean	Required	代表サムネイルかどうか true(デフォルト)\|false

リクエスト例

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

人物の名前を指定して登録

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons' \
--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 '{
  "name": "ホンギルドン",
  "description": "韓国の代表的な仮想人物です。",
  "thumbnails": [
    {
      "thumbnailKey": "persons/thumbnails/hong.jpg",
      "isPrimaryThumbnail": true
    }
  ]
}'

匿名人物として登録

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons' \
--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": "persons/thumbnails/unknown.jpg",
      "isPrimaryThumbnail": true
    }
  ]
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	String	-	API処理結果コード
`message`	String	-	API処理結果メッセージ
`result`	Object	-	作成された人物情報
`result.id`	Integer	-	人物 ID

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

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

レスポンス例

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

{
  "code": "0",
  "message": "success",
  "result": {
    "id": 1001
  }
}