人物タグの登録

VPC環境で利用できます。

人物タグを作成します。

リクエスト

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

メソッド	URI
POST	/api/v1/workspaces/{workspace_name}/person-tags

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`name`	String	Required	作成する人物タグ名 1~30文字ワークスペース内で重複不可

リクエスト例

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

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/person-tags' \
--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": "アナウンサー"
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	String	-	API処理結果コード
`message`	String	-	API処理結果メッセージ
`result`	Object	-	作成された人物タグ情報
`result.id`	Integer	-	人物タブ ID
`result.name`	String	-	人物タグ名
`result.createdTime`	String	-	人物タグ作成日時 ISO 8601形式
`result.createdUserName`	String	-	タグを作成したユーザー名

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

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

レスポンス例

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

{
  "code": "0",
  "message": "success",
  "result": {
    "id": 1001,
    "name": "アナウンサー",
    "createdTime": "2025-08-15T17:13:48",
    "createdUserName": "ホン・*ドン"
  }
}