Set person modification thumbnail

Prev Next

Available in VPC

Add a thumbnail to a person.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v1/workspaces/{workspace_name}/persons/{person_id}/person-thumbnail

Request headers

For information about the headers common to all Media Intelligence APIs, see Media Intelligence request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
workspace_name String Required Workspace name
person_id Integer Required Person ID

Request body

You can include the following data in the body of your request:

Field Type Required Description
thumbnails Array Required List of thumbnails to register
thumbnails[].thumbnailKey String Required Key value of the thumbnail uploaded to Object Storage
thumbnails[].isPrimaryThumbnail Boolean Required Whether it is a main thumbnail
  • true | false

Request example

The request example is as follows:

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons/1001/person-thumbnail' \
--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": "my-workspace/W05xCokQ1v/jiho0.jpg",
      "isPrimaryThumbnail": true
    }
  ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
code String Required API processing result code
message String Required API processing result message
result Object Required Person thumbnail list object

result

Field Type Required Description
thumbnailList Array Required List of thumbnails finally added to the person
  • Existing thumbnail + newly added thumbnail
thumbnailList[].id Integer Required Thumbnail ID
thumbnailList[].url String Required Thumbnail image URL (presigned URL)
thumbnailList[].isPrimaryThumbnail Boolean Required Whether it is a main thumbnail
  • true | false

Response status codes

For information about the HTTP status codes common to all Media Intelligence APIs, see Media Intelligence response status codes.

Response example

The response example is as follows:

{
  "code": "0",
  "message": "success",
  "result": {
    "thumbnailList": [
      {
        "id": 1234,
        "url": "https://kr.object.ncloudstorage.com/.../jiho0.jpg?...",
        "isPrimaryThumbnail": true
      }
    ]
  }
}