ðAPI routes
In this page, learn how to leverage the API routes to implement the User-Generated Emote feature in your game.
Last updated
In this page, learn how to leverage the API routes to implement the User-Generated Emote feature in your game.
Last updated
The OAuth 2.0 method of authentication consists in generating an authentication token. This can then be used as tokenized temporary credentials. The implicit flow is a browser only flow. It can be used in web applications that need access tokens and cannot make use of a backend. Ask for a client ID if you need to implement this flow.
GET https://auth.kinetix.tech/login
Initiates user authentication and redirects to the pre-registered callback URL with the authentication token in the URL fragment.
| Name | Type | Description |
|---|---|---|
POST https://sdk-api.kinetix.tech/v1/plans
Retrieves information about your current subscription plan. You can upgrade your plan at any time on the Kinetix Developer Portal.
Content-Type: application/json
In this section, learn how to let your players communicate with our AI directly though your game, to create emotes.
You will need to send the token you have created in previous endpoint in your header as x-api-token in order to use next endpoint. This token will only be useable for 5 minutes.
This ML process creates an emote from a video file, please be aware the heavier the file you are sending as input is, the longer this process will take.
We recommend you to send videos where only one character is visible.
GET https://sdk-api.kinetix.tech/v1/process/token
Obtain a token to authenticate emote creation processes.
POST https://sdk-api.kinetix.tech/v1/process
Initiates an ML process to generate a user-generated emote from a token.
GET https://sdk-api.kinetix.tech/v1/process/{uuid}
Get a user process status. The user must be associated to requesting virtual world
POST https://sdk-api.kinetix.tech/v1/process/{uuid}/validate
If you want to let your users the capacity to retake an emote, you have to let them validate or not an emote when it's generated. It means that, after generating an emote, players will have two options: validate the process if they're satisfied with the emote output they received, or retake the process. Note that for now, you cannot benefit from the validate/retake process on your own: you have to ask Ben to activate it for you. When the validation flow is activated, this will make the emote available to the user.
POST https://sdk-api.kinetix.tech/v1/process/{uuid}/retake
When the validation flow is activated, this will reject the process and return a new generation token to let the user retry. If you want to let your users the capacity to retake an emote, you have to let them validate or not an emote when it's generated. It means that, after generating an emote, players will have two options: validate the process if they're satisfied with the emote output they received, or retake the process.
GET https://sdk-api.kinetix.tech/v1/process/token/{token}
Determines the status of a previously generated token.
GET https://sdk-api.kinetix.tech/v1/process/dev-token
Create a QR code for the specified user. By default, it will use the virtual world id 1. Virtual World can be changed by specifying one of its keys.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|