๐Ÿ˜Integrate Kinetix API

Integrate Kinetix's API and get started with the User-Generated Emote feature!

The raw swagger documentation API can be found there : https://sdk-api.kinetix.tech/documentation/#/

Welcome to the Kinetix API, a solution designed to integrate the User-Generated Emote feature in any game or app, empowering players to create custom emotes from videos through a seamless and interactive process. This API enables game studios to fully customize the integration of the feature in their game or app.

Make sure you know all about the User-Generated Emote feature before moving on.


Creating an emote creation feature in your game or app, with the Kinetix API

When using the Kinetix API to bring the User-Generated Emote feature in your game, you need to recreate the main steps of the emote creation flow we've designed.

1. Identify your users / players (clients)

Before integrating the Kinetix API into your game, establishing a secure method for authenticating and identifying your users is paramount. Our system leverages OAuth 2.0, a robust protocol designed to ensure that user interactions with Kinetix's AI are securely authenticated. Without the authentication step, it is impossible to associate players with generated emotes.

Authentication ensures that emotes generated through the Kinetix AI are uniquely associated with the correct user account, enabling a personalized gaming experience.

2. Create a token for each emote creation process

Once authenticated, your game will request a token from Kinetixโ€™s API. This token is crucial for initiating the Machine Learning (ML) process that transforms player-submitted videos into custom emotes. It acts as a temporary credential, that allow your game and the Kinetix API to identify and authorize users without directly handling their login credentials. Tokens ensure that each request to the API is authenticated and authorized, enabling a secure and personalized user experience.

3. QR Code Generation and Video Submission

With the token generated, the next step is to create a QR code that players can scan. This QR code directs players to a secure upload interface where they can submit their video. This step emphasizes user-friendliness, allowing players to easily contribute content from their devices.

4. Creating the custom emote

After video submission, your game uses the API to initiate the ML process, sending the video along with the token to Kinetixโ€™s servers. Our advanced AI analyzes the video, crafting a custom animation that captures the playerโ€™s intended emote.

To receive emotes crafted on your players' avatars, you need to upload your game's avatar on the Kinetix Developer Portal. Learn more: Avatar Upload

5. Process Status and Validation

Throughout the ML process, your game can query the API to check the status of the emote creation. Once complete, you'll validate the process, making the emote available in-game. This step ensures that the generated content meets quality standards and is ready for use.

6. Retake option

If necessary, players can retake or adjust their submissions to ensure the final emote perfectly captures their vision. This flexibility enhances user satisfaction by providing options to refine the content. Of course, this part of the feature is totally optional.

7. Integration in your game

Finally, the Kinetix API delivers the user-generated emote, in formats like FBX or GLB, ready to be integrated into your game, allowing the player to use it with their avatar.


Get started with the User-Generated Emote feature, integrating the Kinetix API

Ready to integrate the User-Generated Emote feature with the Kinetix API? Follow the steps below!

STEP 1: Retrieve your game authentification API key

๐Ÿ”‘pageGet your Authentification API key

STEP 2: Explore the API routes

๐Ÿ”ŒpageAPI routes

STEP 3: Integrate Webhooks

๐ŸชpageAPI Webhooks

STEP 4: Learn about the possible return codes of our API

๐Ÿ“pagePossible Return Codes

Have troubles integrating Kinetix API? We're here to help you!

Please send a kind email to Ben, we will be happy to support you.

Last updated