인물 태그 목록 조회

VPC 환경에서 이용 가능합니다.

인물 태그 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/api/v1/workspaces/{workspace_name}/person-tags

요청 헤더

Media AI Understanding API 에서 공통으로 사용하는 헤더에 대한 정보는 Media AI Understanding 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`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://maiu.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	Required	API 처리 결과 코드
`message`	String	Required	API 처리 결과 메시지
`result`	Object	Required	API 반환 정보
`result.content`	Array	Required	인물 태그 목록
`result.totalCount`	Integer	Required	전체 인물 태그 수
`result.totalPage`	Integer	Required	전체 페이지 수
`result.pageNo`	Integer	Required	페이지 번호
`result.pageSize`	Integer	Required	페이지당 항목 수

result.content

result.content 항목에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`id`	Integer	Required	인물 태그 ID
`name`	String	Required	인물 태그 이름
`updatedUserName`	String	Required	태그를 마지막으로 수정한 사용자 이름
`updatedTime`	String	Required	태그 수정 일시 ISO 8601 형식

응답 상태 코드

Media AI Understanding API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Media AI Understanding 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "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
  }