Audios

Audios are binary files containing speech fragments and their associated relevant metadata. The person speaking on them can optionally be identified by linking them to an identity.

Voiceprints can be extracted out of them and different kinds of verifications can be performed on them.

Access: To manage an audio, you must have access to its space.

Isolation: an audio can only interact with resources inside its space.

Fields

idstringrequired

The UUID of the audio. Is unique.

Format: uuid

Example: 00000000-0000-0000-0000-000000000000

handlestringrequired

The handle of the audio. Is unique.

Example: audio-a

aliasstring | nullrequired

The alias of the audio.

Example: Audio A

statestringrequired

The state of the audio.

Format: AudioState (string)

Possible values: [avaitingFile, available, notAvailable]

Example: available

durationstringrequired

The duration of the audio.

Example: PT3.500S

sampleRateintegerrequired

The sampling sample rate of the audio.

Format: int32

Example: 8000

identity

object | null

required

The identity linked to the audio.

handlestringrequired

The handle of the identity. Is unique.

Example: identity-a

aliasstring | nullrequired

The alias of the identity.

Example: Identity A

voiceprintsintegerrequired

The number of voiceprints of the audio.

Format: int32

Example: 10

verificationsintegerrequired

The number of verifications of the audio.

Format: int32

Example: 10

createdAtstringrequired

The date and time when the audio was created.

Format: date-time

Example: 2023-01-01T00:00:00.000000Z

uploadedAtstringrequired

The date and time when the binary file was uploaded.

Format: date-time

Example: 2023-01-01T00:00:00.000000Z

Audio
{
  "id": "00000000-0000-0000-0000-000000000000",
  "handle": "audio-a",
  "alias": "Audio A",
  "state": "available",
  "duration": "PT3.500S",
  "sampleRate": 8000,
  "identity": {
    "handle": "identity-a",
    "alias": "Identity A"
  },
  "voiceprints": 10,
  "verifications": 10,
  "createdAt": "2023-01-01T00:00:00.000000Z",
  "uploadedAt": "2023-01-01T00:00:00.000000Z"
}

Fields​

Fields