인물 수정

Prev Next

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

인물의 정보를 수정합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
workspace_name String Required 워크스페이스 이름
person_id String Required 인물 ID

요청 바디

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

필드 타입 필수 여부 설명
name String Optional 인물 이름
  • 1~50자
  • 워크스페이스 내 중복 불가
  • 공백 문자열 또는 공백만 포함된 경우 등록 불가
description String Optional 인물 설명
  • 1~700자
primaryThumbnailId Integer Optional 대표 썸네일 ID

요청 예시

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

curl --location --request PATCH 'https://maiu.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons/1001' \
--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": "한국의 대표 MC입니다.",
  "primaryThumbnailId": 3002
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
code String Required API 처리 결과 코드
message String Required API 처리 결과 메시지
result Object Required 인물 상세 정보 객체

result

필드 타입 필수 여부 설명
id Integer Required 인물 ID
name String Required 인물 이름
description String Optional 인물 설명
tags Array Required 인물에 설정된 태그 목록
  • 0~
tags[].id Integer Required 태그 ID
tags[].name String Required 태그 이름
thumbnails Array Required 인물에 등록된 썸네일 목록
  • 0~
thumbnails[].id Integer Required 썸네일 ID
thumbnails[].url String Required 썸네일 이미지 URL (Presigned URL)
thumbnails[].isPrimaryThumbnail Boolean Required 대표 썸네일 여부
  • true | false

응답 상태 코드

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

응답 예시

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

{
  "code": "0",
  "message": "success",
  "result": {
    "id": 1001,
    "name": "유재석",
    "description": "한국의 대표 MC입니다.",
    "tags": [
      {
        "id": 202,
        "name": "텔런트"
      }
    ],
    "thumbnails": [
      {
        "id": 3002,
        "url": "https://kr.object.ncloudstorage.com/.../9870829644790204567.jpg?...",
        "isPrimaryThumbnail": true
      }
    ]
  }
}