Introduction
Welcome to the API reference of the Hiya Audio Intelligence APIs. Here you will find detailed descriptions of the endpoints, resources and operations available in our API.
Check the guides for step by step flows to guide you through the most relevant operations.
Check the model index for detailed descriptions of the models available on the platform.
Base URL for API requests -- https://api.loccus.ai/v1
Starting point: below we provide an eagle-eye view of the different sections and it is a good place to start, but you can also use the sidebar to navigate to pages relevant to you.
OpenAPI Definition
The OpenAPI definition file can be used to automatically setup requests in HTTP clients like Postman or to generate code to create a client in a given programming language.
2024.12.r2-beta
IDs, handles, & aliases
The API makes extensive use of three different types of fields to identify and reference resources. Each one follows different rules and is meant for different purposes.
IDs
IDs are UUIDs (Universally Unique Identifiers) and follow their standard format. They are randomly generated by the platform when a resource is created and cannot be changed.
Their purpose is to uniquely identify resources in an invariant way so that the platform can keep track of them throughout their whole lifetime. They are not intended to be used to interact with the API and should only be referenced in debugging contexts.
Example of an ID
986b0cc0-e559-47a1-8226-bedf5002371f
Handles
Handles are hyphen-separated lowercase alphanumeric characters, following a custom format. They are usually user-specified and can be changed at any time, although in some situations they may default to the ID of the resource.
Their purpose is to uniquely identify resources in a human-friendly way, while maintaining a restrictive, URL-friendly format. They are the only valid way to reference resources in path and body parameters.
Example of a handle
th1s-1s-a-handle
Local and global handles
Although handles allow us to uniquely identify resources, some of them are not globally unique and are instead local to a certain context.
For example, two API keys may have the same handle as long as they belong to different users, each being uniquely identifiable in its own context.
Example of two API keys of different users with the same handle
/users/alice/keys/main
/users/bob/keys/main
Composite handles
Some resources are tightly related to a different resource but not nested under it, in those cases composite handles are used to uniquely identify resources.
For example, two spaces may have the same handle as long as they belong to different owners, each being uniquely identifiable by their composite handle.
Example of two spaces of different owners with the same handle
/spaces/alice/poc
/spaces/bob/poc
Aliases
Aliases are UTF-8 strings with no formatting restrictions. They are optional, user-specified, and can be changed at any time.
Their purpose is to give users full control over how resources are represented in UIs, and they do not uniquely identify resources.
Example of an alias
Thís îs an alïas! かっこいい!
Custom field formats
The string fields defined in our OpenAPI definition make use of the following formats.