Sign in

v2

latestSwagger 2.02026-07-13152047.5 KB
text-dependent

Enroll Profile

Adds an enrollment to existing profile. If the minimum number of requested enrollment audios is reached, a voice print is created. If the voice print was created before, it gets recreated from all existing enrollment audios including the new one.

Limitations:

  • Minimum audio input length per request is 1 second
  • Maximum audio input length per request is 10 seconds
  • Minimum number of enrollments for creating a voiceprint is 3
  • Maximum number of enrollments for creating a voiceprint is 50
  • Minimum audio Signal-to-noise ratio (SNR) is 10dB

Constraints:

  • First enrollment must match an existing passphrase.
  • All enrollments after the first one, must use the same passphrase used in the first enrollment.
post/text-dependent/profiles/{profileId}/enrollments

Response

Created

profileIdstring uuid

Unique identifier for profile id (guid).

enrollmentStatus'Enrolling' | 'Training' | 'Enrolled'

Status representing the current state of the profile. Available values are:

  • Enrolling: profile has no voice print and not ready for recognition requests.
  • Training: voice print of profile is being created and can’t be used for recognition at the moment.
  • Enrolled: profile has a voice print and ready for recognition requests.
enrollmentsCountinteger

Number of enrolment audios accepted for this profile.

enrollmentsLengthnumber

Total length of enrollment audios accepted for this profile in seconds.

enrollmentsSpeechLengthnumber

Summation of pure speech (which is the amount of audio after removing silence and non-speech segments) across all profile enrollments in seconds.

remainingEnrollmentsCountinteger

Number of enrollment audios needed to complete profile enrollment.

passPhrasestring

Passphrase associated with this enrollment.

audioLengthnumber

This enrolment audio length in seconds.

audioSpeechLengthnumber

This enrollment audio pure speech (which is the amount of audio after removing silence and non-speech segments) length in seconds.

Example response

{
  "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
  "enrollmentStatus": "Enrolling",
  "enrollmentsCount": 1,
  "enrollmentsLength": 1.83,
  "enrollmentsSpeechLength": 1.35,
  "remainingEnrollmentsCount": 2,
  "passPhrase": "my voice is my passport verify me",
  "audioLength": 1.83,
  "audioSpeechLength": 1.35
}