Skip to main content

speechly.identity.v1.Identity

Speechly Identity API is used for creating access tokens for the Speechly APIs.

Methods

namerequestresponsedescription
LoginLoginRequestLoginResponsePerforms a login of specific Speechly application.
Returns an access token, that can be used to access Speechly SLU API.

Messages

LoginRequest

Top-level message sent by the client for the Login method.

Fields

nametypedescription
device_idstringA unique end-user device identifier.
Must be UUID.
Required.
app_idstringSpeechly application ID.
Required.
language_codestringThe language to use.
Must be a supported BCP-47 language code, eg. 'en-US'.
Defaults to the application's language.
config_idstringDefine a specific model configuration to use.
Defaults to the application's latest configuration.

LoginResponse

Top-level message sent by the server for the Login method.

Fields

nametypedescription
tokenstringAccess token which can used for Speechly SLU API.
The token is a JSON Web Token and includes all standard claims, as well as custom ones.
The token has expiration, so you should check whether it has expired before using it.
It is safe to cache the token for future use until its expiration date.