Links
Comment on page

Test guidelines

Find all the best practices for an optimal usage of Kinetix AI Animation API
You can test our API with Swagger here: https://animate-api.kinetix.tech/documentation/#/

Testing AI Animation API with Swagger

We will guide you through the easiest way to test Kinetix AI Animation API routes with Swagger without the need of any specific front-end development.

1. Get your API key

Get your API Key following the steps of How to get your API key?

2. Authenticate your key in Swagger

  1. 1.
    Click here to access the API swagger
  2. 2.
    Authenticate yourself with the API key previously created (and carefully stored)
    1. 1.
      Click on "Authorize" on the top right
    2. 2.
      Paste your API key in "read" and "write" values and click on "Authorize" for each

3. For video to animation, initiate process in POST/v1/process/video

  1. 1.
    Clicking on POST /v1/process/video "Create a ML Process"
  2. 2.
    Click on "Try it out" button
  3. 3.
    Configure and upload the desired input
    1. 1.
      Optional: Define Start & End to Trim video (if left empty API will process full video) by default video trim length is set to 10 seconds
    2. 2.
      Browse and upload your desired video input (see Input characteristicsfor more info about input guidelines)
    3. 3.
      Click on "Execute" to launch the ML processing
  4. 4.
    Verify the request status
    if Answer code = 201 = successful request if Answer code = 401 = Unauthorized if Answer code = 400 = Bad Request
  5. 5.
    If successful request, copy and carefully save the UUID associated to the request and identify the associated input video
TIP: you can initiate several ML processing in a raw

4. For text to animation, initiate process in POST/v1/process/text

  1. 1.
    Click on POST /v1/process/video "Create a ML process from text"
  1. 1.
    Click on "Try it out" button
  2. 2.
    Input desired text in dedicated field

Optional: Check process progress in GET/v1/process/{uuid}

  1. 1.
    Click on "Get process progression"
  2. 2.
    Click on “Try it out” to activate function
  3. 3.
    Input UUID in blank field
  4. 4.
    Click on “Execute” to get status of pipeline
  5. 5.
    Check associated status

5. Download API output with GET/v1/process/{uuid}/download

  1. 1.
    Open GET/v1/process/{uuid}/download
  2. 2.
    Click on “Try it out” to activate function
    1. 1.
      rig: If you don't want to use contact aware retargeting, you can choose in between rpm and omniverse rig, otherwise keep this field empty
    2. 2.
      avatar: To launch the Contact aware retargeting on your desired avatar, paste desired avatar ID accessible once you have uploaded your avatar in Animation API portal
    3. 3.
      format: Choose desired format
      1. 1.
        .GLB
      2. 2.
        .FBX
      3. 3.
        .USDz
    4. 4.
      uuid: Paste UUID associated with the request previously initiated
  3. 3.
    Click on "Execute"
    If you have launched a contact aware retargeting, there is processing time associated for the retargeting to operate on your desired avatar.
  4. 4.
    Click on "Download file" button
    Reminder: If no avatar ID has been configured, the output file is retargeted on a Kinetix RPM avatar.
The processing time for contact aware retargeting is approximately 2.5 min for a 10 seconds animation.