2024.10.r3-beta

Hiya

Guides

Use Cases

API Reference

Changelog

Model Index

🎉 Loccus.ai is now part of Hiya Inc.!

Status

OpenAPI definition

Introduction

Authenticate using credentials

Authenticate using your credentials

Authenticate using API keys

Authenticate using your API keys

Upload an audio

Create an identity

Compute a voiceprint

Overview

Perform a verification

Identity

Perform an identity verification

Authenticity

Perform an authenticity verification

Message

Perform a message verification

Basic Authenticity Use Case

Call Center Use Case

Caller ID Use Case

Authenticity Best Practices

Basic Identity Use Case

Identity Best Practices

Testing the platform

Frequently Asked Questions

Ids, handles and aliases

Custom field formats

Bearer tokens

Credentials

Start a new session using your credentials.

Sign in

Sign in with your credentials

Update your password by providing the new one.

Update password

Update your password

API keys

List the paginated details of your API keys.

List

List your API keys

Create a new API key by providing its details.

Create

Create an API key

Get an API key

Update an API key by providing its new details.

Update

Update an API key

Delete an API key. The deletion does not have side effects.

Delete

Delete an API key

Your user

Get your user

Update your user by providing its new details.

Update your user

List the paginated details of your organizations.

List organizations

List your organizations

List the paginated details of your spaces.

List spaces

List your spaces

Users

Get a user

Organizations

Get an organization

Update an organization by providing its new details.

Update an organization

List the paginated details of the members of an organization.

List members

List the members of an organization

List the paginated details of the spaces of an organization.

List the spaces of an organization

Spaces

Get a space

Update a space by providing its new details.

Update a space

Get the details of the configuration of a space.

Get config

Get the configuration of a space

Update the configuration of a space by providing its new details.

Update config

Update the configuration of a space

Audios

Requirements

Media file requirements for upload

Base64 encoding

Media file encoding in Base64

List the paginated details of the audios in a space.

List the audios in a space

Create a new audio by providing its details.

Create an audio

Get an audio

Update an audio by providing its new details.

Update an audio

Identify

Identify an audio

Download binary file

Download the binary file of an audio

Upload binary file

Upload the binary file of an audio

Delete binary file

Delete the binary file of an audio

List the paginated details of the voiceprints of an audio.

List voiceprints

List the voiceprints of an audio

List the paginated details of the verifications of an audio.

List verifications

List the verifications of an audio

Identities

List the paginated details of the identities in a space.

List the identities in a space

Create a new identity by providing its details.

Get an identity

Update an identity by providing its new details.

Update an identity

Delete an identity

List the paginated details of the audios of an identity.

List audios

List the audios of an identity

List the paginated details of the voiceprints of an identity.

List the voiceprints of an identity

Voiceprints

Audio requirements

Audio requirements for voiceprints

List the paginated details of the voiceprints in a space.

List the voiceprints in a space

Create a new voiceprint by providing its details.

Create a voiceprint

Get a voiceprint

Update a voiceprint by providing its new details.

Update a voiceprint

Delete a voiceprint

Compute

List the paginated details of the audios of a voiceprint.

List the audios of a voiceprint

Add audio

Add an audio to a voiceprint

Remove audio

Remove an audio from a voiceprint

List the paginated details of the verifications of a voiceprint.

List the verifications of a voiceprint

Verifications

Audio requirements for verifications

Scores

Verification scores

Thresholds

Verification thresholds

List the paginated details of the verifications in a space.

List the verifications in a space

Usage statistics

Get the usage statistics of a space

Usage records

Product Updates

Voiceprint models

Verification models

Identity verification models

default — v1.0

Identity verification model

Authenticity verification models

default — v10

Authenticity verification model

telephone — v6

Message verification models

default — v2

Message verification model

Getting Started

Authentication

Structure and Access

Speech Data

Results

Usage

OpenAPI definition

2024.10.r3-beta

Download YAML

Download JSON

Getting Started

Authentication

Structure and Access

Speech Data

Results

Usage

​2024.10.r3-beta

Download YAML

Download JSON

2024.10.r3-beta