人物リストの照会

VPC環境で利用できます。

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

参考

人物 IDの複数指定、命名状態フィルタ、ソート基準の指定など、複合条件で照会する場合は人物の検索をご使用ください。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`pageNum`	Integer	Required	ページ番号 1以上
`pageSize`	Integer	Optional	ページごとの項目数 1~1000 (デフォルト: 1000)
`name`	String	Optional	検索する人物名 2~50文字セミコロン(`;`)、バーティカルバー(`\\|`)、バッククォート(`)は使用不可
`tagIdList`	Array<Integer>	Optional	検索する人物タグ IDリスト `,`で区切って複数の IDを入力可能最大30個

リクエスト例

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

curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons?pageNum=1&pageSize=10&name=홍길동&tagIdList=100,200' \
--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	-	人物リスト照会の結果
`result.content`	Array	-	人物リスト: content
`result.totalCount`	Integer	-	人物の総数
`result.totalPage`	Integer	-	ページの総数
`result.pageNo`	Integer	-	現在のページ番号
`result.pageSize`	Integer	-	ページごとの項目数

`content`

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

フィールド	タイプ	必須の有無	説明
`id`	Integer	-	人物 ID
`personId`	Integer	-	人物 ID `id`と同一の値
`name`	String	-	人物名匿名人物は nullと表示
`description`	String	-	人物の説明
`tagNames`	Array	-	人物タグ名リスト 0~N
`tags`	Array	-	人物に設定されているタグリスト: tags 0~N タグ IDが必要な場合は、`tagNames`の代わりに使用
`assetCount`	Integer	-	その人物が登場するアセットの数
`thumbnailId`	Integer	-	代表サムネイル ID
`thumbnailUrl`	String	-	代表サムネイル画像 URL Presigned URL
`updatedTime`	String	-	人物情報の最終更新日時 ISO 8601形式
`updatedUserName`	String	-	人物情報を最後に更新したユーザー名

`tags`

tagsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	Integer	-	タグ ID
`name`	String	-	タグ名

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

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

レスポンス例

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

{
  "code": "0",
  "message": "success",
  "result": {
    "content": [
      {
        "id": 1001,
        "personId": 1001,
        "name": "ホンギルドン",
        "description": "韓国の代表的な仮想人物です。",
        "tagNames": ["歌手", "テレビ俳優"],
        "tags": [
          {
            "id": 201,
            "name": "歌手"
          },
          {
            "id": 202,
            "name": "タレント"
          }
        ],
        "assetCount": 12,
        "thumbnailId": 3001,
        "thumbnailUrl": "https://maiu.presigned.ncloudstorage.com/persons/thumbnails/hong.jpg?...",
        "updatedTime": "2025-08-15T17:13:48Z",
        "updatedUserName": "ホン*ドン"
      }
    ],
    "totalCount": 2,
    "totalPage": 1,
    "pageNo": 1,
    "pageSize": 10
  }
}