人物タグリストの照会

VPC環境で利用できます。

人物タグリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`id`	Integer	Optional	人物タブ ID
`name`	String	Optional	人物タグ名 1~30文字
`pageNum`	Integer	Required	ページ番号 1以上
`pageSize`	Integer	Optional	ページごとの項目数 1~50 (デフォルト: 10)

リクエスト例

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

curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/person-tags?pageNum=1&pageSize=10' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	String	-	API処理結果コード
`message`	String	-	API処理結果メッセージ
`result`	Object	-	APIリターン情報
`result.content`	Array	-	人物タグリスト: content
`result.totalCount`	Integer	-	人物タグの総数
`result.totalPage`	Integer	-	ページの総数
`result.pageNo`	Integer	-	ページ番号
`result.pageSize`	Integer	-	ページごとの項目数

`content`

content項目の説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	Integer	-	人物タブ ID
`name`	String	-	人物タグ名
`updatedUserName`	String	-	タグを最後に更新したユーザー名
`updatedTime`	String	-	タグ更新日時 ISO 8601形式

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

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

レスポンス例

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

{
  "code": "0",
  "message": "success",
  "result": {
    "content": [
      {
        "id": 1001,
        "name": "アナウンサー",
        "updatedUserName": "ホン・*ドン",
        "updatedTime": ""2025-08-15T17:13:48""
      },
      {
        "id": 1002,
        "name": "歌手",
        "updatedUserName": "キム・*ス",
        "updatedTime": "2025-08-16T03:22:11.198Z"
      }
    ],
    "totalCount": 2,
    "totalPage": 1,
    "pageNo": 1,
    "pageSize": 10
  }