Create a new person in a specified Person Group. To add face to this person, please call "Add Person Group Person Face".

Changed on

[!NOTE]

    • Free-tier subscription quota:
      • 1,000 persons in all Person Groups.
    • S0-tier subscription quota:
      • 10,000 persons per Person Group.
      • 1,000,000 Person Groups.
      • 100,000,000 persons in all Person Groups.
post/persongroups/{personGroupId}/persons

Request

  • Base URL
    {endpoint}/face/{apiVersion}
  • Auth
    • API key in header Ocp-Apim-Subscription-Key
    • or OAuth 2
      Authorization codehttps://api.example.com/oauth2/authorize
      Token URLhttps://api.example.com/oauth2/token
      Scopeshttps://cognitiveservices.azure.com/.default

Path parameters

personGroupIdstring required

ID of the container.

Request body

namestring required

User defined name, maximum length is 128.

userDatastring

Optional user defined data. Length should not exceed 16K.

Response

A successful call returns a new personId created.

personIdstring uuid required

Universally Unique Identifier

Changes

    • info

      api operation id PersonGroupPerson_Create removed and replaced with PersonGroupOperations_CreatePersonGroupPerson