Skip to main content

Spaces

Spaces act as containers and keep speech data and results bundled and isolated. They belong to either a user or an organization.

To learn how to view the usage statistics of a space, check the usage section.

Access: To manage a space, it must either belong to your user or to one of your organizations.

Composite handle: Spaces are tightly related to their owner and their handle is only unique in combination with them. Learn more.

Content

Users can upload and import speech data into a space. The platform generates results by extracting and analyzing characteristics of that data.

 

Fields


    idstringrequired

    The UUID of the space. Is unique.

    Format: uuid
    Example: 00000000-0000-0000-0000-000000000000

    handlestringrequired

    The handle of the space. Is unique.

    Example: space-a

    aliasstring | nullrequired

    The alias of the space.

    Example: Space A

    owner

    object

    required

    The owner of the space.


    typestringrequired

    The type of the owner.

    Format: OwnerType (string)

    Possible values: [user, org]

    Example: user

    handlestringrequired

    The handle of the owner. Is unique.

    Example: user-a

    aliasstring | nullrequired

    The alias of the owner.

    Example: User A

    audiosintegerrequired

    The number of audios of the space.

    Format: int32
    Example: 10

    voiceprintsintegerrequired

    The number of voiceprints of the space.

    Format: int32
    Example: 10

    verificationsintegerrequired

    The number of verifications of the space.

    Format: int32
    Example: 10

    identitiesintegerrequired

    The number of identities of the space.

    Format: int32
    Example: 10

    createdAtstringrequired

    The date and time when the space was created.

    Format: date-time
    Example: 2023-01-01T00:00:00.000000Z
Space
{
"id": "00000000-0000-0000-0000-000000000000",
"handle": "space-a",
"alias": "Space A",
"owner": {
"type": "user",
"handle": "user-a",
"alias": "User A"
},
"audios": 10,
"voiceprints": 10,
"verifications": 10,
"identities": 10,
"createdAt": "2023-01-01T00:00:00.000000Z"
}