인물 등록

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

신규 인물을 추가합니다. 인물 이름을 입력하지 않으면 이름이 없는 익명 인물로 등록되며, 이후 인물 정보 수정으로 이름을 지정할 수 있습니다.

참고

동일 인물이 이미 등록되어 있는지 확인하려면 등록 전 인물 비교로 유사 인물을 조회해 주십시오.

요청

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

메서드	URI
POST	/api/v1/workspaces/{workspace_name}/persons

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`workspace_name`	String	Required	워크스페이스 이름

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`name`	String	Optional	인물 이름 1~50자 워크스페이스 내 중복 불가 미입력 또는 null 입력 시 익명 인물로 등록 공백 문자열 또는 공백만 포함된 경우 등록 불가
`description`	String	Optional	인물 설명 1~700자
`thumbnails`	Array	Required	등록할 썸네일 목록 최대 100개까지 등록 가능 각 항목은 `thumbnailKey`와 `isPrimaryThumbnail` 필드 포함 대표 썸네일은 하나만 지정 가능
`thumbnails[].thumbnailKey`	String	Required	업로드된 썸네일의 키 값 <예시> `persons/thumbnails/hong.jpg`
`thumbnails[].isPrimaryThumbnail`	Boolean	Required	대표 썸네일 여부 true(기본값) \| false

요청 예시

요청 예시는 다음과 같습니다.

인물 이름을 지정하여 등록

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons' \
--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 '{
  "name": "홍길동",
  "description": "한국의 대표적인 가상 인물입니다.",
  "thumbnails": [
    {
      "thumbnailKey": "persons/thumbnails/hong.jpg",
      "isPrimaryThumbnail": true
    }
  ]
}'

익명 인물로 등록

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons' \
--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 '{
  "thumbnails": [
    {
      "thumbnailKey": "persons/thumbnails/unknown.jpg",
      "isPrimaryThumbnail": true
    }
  ]
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`code`	String	-	API 처리 결과 코드
`message`	String	-	API 처리 결과 메시지
`result`	Object	-	생성된 인물 정보
`result.id`	Integer	-	인물 ID

응답 상태 코드

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

응답 예시

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

{
  "code": "0",
  "message": "success",
  "result": {
    "id": 1001
  }
}