VPC 환경에서 이용 가능합니다.
인물 이름, 인물 ID, 인물 태그, 명명 상태 등의 복합 조건으로 워크스페이스 내 인물을 검색합니다. 검색 조건과 정렬 기준을 요청 바디로 전달합니다.
참고
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| POST | /api/v1/workspaces/{workspace_name}/persons/search |
요청 헤더
Media Intelligence API에서 공통으로 사용하는 헤더에 대한 정보는 Media Intelligence 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
workspace_name |
String | Required | 워크스페이스 이름 |
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
pageNum |
Integer | Required | 페이지 번호
|
pageSize |
Integer | Optional | 페이지당 항목 수
|
name |
String | Optional | 검색할 인물 이름
|
personIds |
Array[Integer] | Optional | 검색할 인물 ID 목록
|
tagIds |
Array[Integer] | Optional | 검색할 인물 태그 ID 목록
|
nameType |
String | Optional | 인물의 명명 상태
|
sortColumn |
String | Optional | 정렬 기준 항목
|
sortType |
String | Optional | 정렬 방향
|
요청 예시
요청 예시는 다음과 같습니다.
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
|
name |
String | - | 인물 이름
|
description |
String | - | 인물 설명 |
tags |
Array | - | 인물에 설정된 태그 목록: tags
|
assetCount |
Integer | - | 해당 인물이 등장하는 에셋 수 |
thumbnailId |
Integer | - | 대표 썸네일 ID |
thumbnailUrl |
String | - | 대표 썸네일 이미지 URL
|
updatedTime |
String | - | 인물 정보 최종 수정 일시
|
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
}
}