Comment on page

Getting started

Let's set up AI Animation API and transform any human based video into a 3D animation!


The Animate API uses API keys to authenticate requests. You can view and manage your API keys in the Animation Creator tool Dashboard.

How to get your API key?

  1. 1.
    Register your game in AI Animation dashboard
  2. 2.
    Retrieve your API key by clicking on "Request Production API Key"
  3. 3.
    Once the key displayed make sure to copy and paste it in a safe place
  4. 4.
    You can now use our Animation API with this API Key
VERY IMPORTANT: For security reasons, the API key only appears once, make sure to copy/paste it in a safe place (ideally digital vault) when displayed in . If you were to lose it, you will only be able to revoke the previous key and create a new one.

Use your API key

Requests must include the following key in headers:
x-api-key: <your_api_key>

OAuth 2.0 authentication - implicit flow

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.
Authorization endpoint

Get an animation from a video

Create a ML process from a video or text
Get process progression
Download a process output