speechly.identity.v2.IdentityAPI

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

Methods

name	request	response	description
Login	LoginRequest	LoginResponse	Performs a login of specific Speechly application. Returns an access token which can be used to access the Speechly API.

Used as the scope in LoginRequest when the access is for a single Speechly application.

name	type	description
app_id	string	Speechly application ID. The defined application can be accessed with the returned token. Required.
config_id	string	Define a specific model configuration to use. Defaults to the application's latest configuration.

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

name	type	description
device_id	string	A unique end-user device identifier. Must be a `UUID`. Required.
application	ApplicationScope	Login scope application: use the given application context for all utterances.
project	ProjectScope	Login scope project: define the target application per utterance. The target applications must be located in the same project.

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

name	type	description
token	string	Access token which can used for the Speechly 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.
valid_for_s	uint32	Amount of seconds the returned token is valid.
expires_at_epoch	uint64	Token expiration time in seconds after 1970-01-01 ("unix time").
expires_at	string	ISO-formatted UTC timestamp of the expiration time of the returned token.

Used as the scope in LoginRequest when access is required for every application in a Speechly project.

name	type	description
project_id	string	Speechly project ID. Every application in the same project is accessible with the same token. Required.