人物の検索

VPC環境で利用できます。

人物名、人物 ID、人物タグ、命名状態などの複合条件でワークスペース内の人物を検索します。検索条件とソート基準をリクエストボディで渡します。

参考

人物照会 APIは用途に応じて次のように区分されています。簡易リスト照会には人物リストの照会を、複合条件での検索やソートには人物の検索をご使用ください。

人物の詳細照会: 人物1件の詳細情報を照会
人物リストの照会: 人物名・タグに基づく簡易リストを照会
人物の検索: 人物 IDの複数指定、命名状態による絞り込み、ソート基準の指定など、複合条件による検索

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`pageNum`	Integer	Required	ページ番号 1以上
`pageSize`	Integer	Optional	ページごとの項目数 1~50 (デフォルト: 10)
`name`	String	Optional	検索する人物名 2~50文字セミコロン(`;`)、バーティカルバー(`\\|`)、バッククォート(`)は使用不可
`personIds`	Array[Integer]	Optional	検索する人物 IDリスト最大50個人物リストの照会を参照
`tagIds`	Array[Integer]	Optional	検索する人物タグ IDリスト最大30個人物タグリストの照会を参照
`nameType`	String	Optional	人物の命名状態 `NAMED` \| `ANONYMOUS` `NAMED`: 名前が指定された人物 `ANONYMOUS`: 名前がない匿名人物未入力時、全人物を照会
`sortColumn`	String	Optional	ソート基準項目 `ASSET_COUNT` (デフォルト) \| `CREATED_AT` \| `PERSON_ID` \| `NAME`
`sortType`	String	Optional	ソート方向 `ASC` \| `DESC` (デフォルト)

リクエスト例

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

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons/search' \
--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 '{
  "pageNum": 1,
  "pageSize": 10,
  "tagIds": [200],
  "nameType": "NAMED",
  "sortColumn": "ASSET_COUNT",
  "sortType": "DESC"
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`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	-	人物の説明
`tags`	Array	-	人物に設定されたタグリスト: tags 0~N
`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": "韓国の代表的な仮想人物です。",
        "tags": [
          {
            "id": 200,
            "name": "歌手"
          }
        ],
        "assetCount": 12,
        "thumbnailId": 3001,
        "thumbnailUrl": "https://maiu.presigned.ncloudstorage.com/persons/thumbnails/hong.jpg?...",
        "updatedTime": "2026-09-01T17:13:48Z",
        "updatedUserName": "ホン*ドン"
      }
    ],
    "totalCount": 1,
    "totalPage": 1,
    "pageNo": 1,
    "pageSize": 10
  }
}