Name: NVIDIA Kimodo API: Text to 3D Character Motion
Brand: magicapi
SKU: api-magicapi-text-to-motion-generator-sprited-kimodo
Availability: InStock
Author: API Market

Shashank Agarwal

# 🕺 Text-to-Motion Animation Generator API (NVIDIA Kimodo)

## Overview
Kimodo is a text-to-motion model from NVIDIA research. This listing is an unofficial deployment published by Sprited. Its developer describes it as offering SOMA and G1 models, sequential prompts, motion constraints, multi-sample generation, GLB, BVH, NPZ and Mixamo FBX export, and animated previews.

Describe a movement in `prompt` and set its `duration`. The model generates a 3D character motion and returns a list of file URLs: the motion file(s) in the chosen `output_format` and, with `preview` on (default), an MP4 preview of the motion.

## Features
- **Text to 3D motion**: describe a movement and get an animated skeleton motion.
- **Sequential segments**: periods in `prompt` separate motion segments that play one after another. `duration` (0.5 to 30 seconds, default 5) applies per segment, or set one duration per segment in `segment_durations`.
- **Seven checkpoints**: `model` is one of `Kimodo-SOMA-RP-v1`, `Kimodo-SOMA-RP-v1.1` (default), `Kimodo-SMPLX-RP-v1`, `Kimodo-G1-RP-v1`, `Kimodo-SOMA-SEED-v1`, `Kimodo-SOMA-SEED-v1.1` and `Kimodo-G1-SEED-v1`.
- **Export formats**: `output_format` is `glb` (default), `bvh`, `npz`, `fbx` or `all`. Send a Mixamo-rigged character in `custom_fbx` to retarget the FBX export (SOMA models only).
- **Several samples**: `num_samples` (1 to 16) generates alternative motions; `sample_index` picks the one used for the preview and FBX.
- **Constraints**: upload a Kimodo constraints JSON array file and pass its URL in `constraints_json`.
- **Extras**: `include_auxiliary` also returns an interactive HTML viewer and metadata JSON; `output_delivery` `bundle` packages the files in a ZIP.

## Use Cases
1. **Game and app prototyping**: create placeholder character animations from text.
2. **Animation drafts**: block out motion for 3D scenes and import the GLB, BVH or FBX file into your tools.
3. **Mixamo characters**: retarget generated motion to your own rigged character with `custom_fbx`.
4. **Motion variations**: generate several samples of the same action and pick the best one.

## Visual Examples
### Example Input
Prompt: "A person performs jumping jacks, repeatedly spreading both legs and raising both arms overhead, then returning to a standing position."

Settings: `model` `Kimodo-SOMA-RP-v1.1`, `duration` `3.5`, `num_samples` `1`, `diffusion_steps` `100`, `seed` `42`, `postprocess` `true`, `preview` `true`, `image_size` `512`. All other fields were left at their defaults (`output_format` `glb`).

### Example Output
The response listed two files: the MP4 preview and the GLB motion file (`kimodo_motion_00.glb`, about 1.6 MB). The preview:

[Watch the example output](https://blog.api.market/wp-content/uploads/2026/10/kimodo-output-1-0qshhngj-api-market.mp4)

## Input Parameters
| Field | Type | Required | Default | Allowed values | Description |
| --- | --- | --- | --- | --- | --- |
| `prompt` | string | Yes | none |  | Motion description. Periods separate sequential motion segments |
| `model` | string | No | `Kimodo-SOMA-RP-v1.1` | `Kimodo-SOMA-RP-v1`, `Kimodo-SOMA-RP-v1.1`, `Kimodo-SMPLX-RP-v1`, `Kimodo-G1-RP-v1`, `Kimodo-SOMA-SEED-v1`, `Kimodo-SOMA-SEED-v1.1`, `Kimodo-G1-SEED-v1` | Kimodo model checkpoint |
| `duration` | number | No | `5` | 0.5 to 30 | Seconds per segment |
| `segment_durations` | string | No | `""` |  | Optional JSON array of durations, one per segment |
| `seed` | integer | No | `42` | 0 to 4294967295 | Random seed |
| `num_samples` | integer | No | `1` | 1 to 16 | Number of motion samples to generate |
| `diffusion_steps` | integer | No | `100` | 10 to 500 | Number of diffusion steps |
| `constraints_json` | string (URL) | No | none |  | URL of an uploaded Kimodo constraints JSON array |
| `postprocess` | boolean | No | `true` |  | Foot-skate cleanup; skipped for G1 models |
| `root_margin` | number | No | `0.04` | 0 to 1 | Root margin setting |
| `output_format` | string | No | `glb` | `glb`, `bvh`, `npz`, `fbx`, `all` | Motion file format. GLB is the default; `all` exports every supported format |
| `output_delivery` | string | No | `individual` | `bundle`, `individual` | `individual` returns the selected motion files directly; `bundle` packages them in a ZIP |
| `include_auxiliary` | boolean | No | `false` |  | Also return an interactive HTML viewer and metadata JSON |
| `skeleton_mesh` | boolean | No | `true` |  | Include a visible animated skeleton stand-in in GLB. Disable for joint-animation-only export |
| `filename_prefix` | string | No | `kimodo_motion` |  | Prefix for the output file names |
| `sample_index` | integer | No | `0` | 0 to 15 | Sample used for previews and FBX; NPZ, GLB and BVH export every sample |
| `preview` | boolean | No | `true` |  | Return an MP4 motion preview alongside the selected motion files |
| `image_size` | integer | No | `512` | 256 to 1024 | Image size of the preview render in pixels |
| `custom_fbx` | string (URL) | No | none |  | Mixamo-rigged FBX character URL for retargeted FBX export (SOMA models only) |
| `yaw_offset` | number | No | `0` | -180 to 180 | Yaw offset in degrees |
| `scale` | number | No | `0` | 0 to 10 | FBX scale; 0 means automatic height matching |

## Pricing
- **Pay As You Go (PAYG) pricing**: you only pay for what you use.
- **Price**: $0.022 per API unit.
- **1 API unit = 1 request with up to 20 seconds of processing.** A request that takes longer uses one unit per started block of 20 seconds (for example, 45 seconds of processing uses 3 units, $0.066).
- Longer motions, more `num_samples`, more `diffusion_steps` and extra exports take longer and can use more units.
- **Example cost**: the example request took 29.7 seconds of processing, which is 2 units (2 x $0.022) = **$0.044**.
- **Failed or cancelled predictions are not billed.**
- **GET requests to check prediction status** are free and don't count toward API unit usage.
- **No monthly subscription fee.**

## API Documentation

### Base URL
All API requests go to: `https://prod.api.market/api/v1/magicapi/text-to-motion-generator-sprited-kimodo`

### Authentication
Send your api.market API key in the `x-api-market-key` header:
```
x-api-market-key: YOUR_API_MARKET_KEY
```

### Asynchronous Processing
**IMPORTANT**: This API is asynchronous. The flow is:
1. Send a POST request to `/predictions`. A successful request returns **201 Created** with a prediction `id` and a `status` of `starting` or `processing`.
2. Poll GET `/predictions/{id}` with that ID.
3. Keep polling while `status` is `starting` or `processing`.
4. Stop when `status` is `succeeded` (read `output`), `failed` or `canceled` (read `error`).

A polling interval of 2 seconds and an overall timeout of 900 seconds (15 minutes) work well.

### Endpoints

#### Create a Prediction
```bash
curl -X POST "https://prod.api.market/api/v1/magicapi/text-to-motion-generator-sprited-kimodo/predictions" \
  -H "Content-Type: application/json" \
  -H "x-api-market-key: YOUR_API_MARKET_KEY" \
  -d '{
    "version": "17111248e89aa145d768cc1e5f7baae228f69d854b996b860becfee287379545",
    "input": {
      "seed": 42,
      "model": "Kimodo-SOMA-RP-v1.1",
      "prompt": "A person performs jumping jacks, repeatedly spreading both legs and raising both arms overhead, then returning to a standing position.",
      "preview": true,
      "duration": 3.5,
      "image_size": 512,
      "num_samples": 1,
      "postprocess": true,
      "diffusion_steps": 100
    }
  }'
```

Response (201 Created):
```json
{
  "id": "0qshhngjnnrmr0d1d1asnd1b34",
  "version": "17111248e89aa145d768cc1e5f7baae228f69d854b996b860becfee287379545",
  "status": "starting",
  "created_at": "2026-10-23T10:36:08.381Z"
}
```

#### Check Prediction Status
```bash
curl -X GET "https://prod.api.market/api/v1/magicapi/text-to-motion-generator-sprited-kimodo/predictions/{id}" \
  -H "x-api-market-key: YOUR_API_MARKET_KEY"
```

Response when the prediction has finished (200 OK):
```json
{
  "id": "0qshhngjnnrmr0d1d1asnd1b34",
  "status": "succeeded",
  "output": ["https://blog.api.market/wp-content/uploads/2026/10/kimodo-output-1-0qshhngj-api-market.mp4"],
  "error": null,
  "created_at": "2026-10-23T10:36:08.381Z",
  "started_at": "2026-10-23T10:38:35.967Z",
  "completed_at": "2026-10-23T10:39:05.660Z"
}
```

`output` is a list of file URLs: the motion file(s) in the chosen `output_format` and, when `preview` is on, an MP4 preview. The example above shows only the preview; the real response also listed the GLB motion file.

### Status Codes
- **201 Created**: prediction created (POST `/predictions`). This is the normal success response.
- **200 OK**: prediction details returned (GET `/predictions/{id}`).
- **400 Bad Request**: invalid input, for example a missing `prompt`, a `duration` outside 0.5 to 30, or a `num_samples` above 16.
- **401 Unauthorized**: missing or invalid API key.
- **404 Not Found**: no prediction with that ID.
- **429 Too Many Requests**: rate limit exceeded.
- **500 Internal Server Error** or **503 Service Unavailable**: temporary server problem; retry later.

## Rate Limits
All plans allow 10 requests per second. Requests above that return `429 Too Many Requests`; back off before retrying and honour any `Retry-After` header. Polling a prediction with GET is free but still counts toward the per-second limit, so poll every 1 to 5 seconds rather than in a tight loop.

## Error Handling
- Check the HTTP status code of every request and read the response body for the error message.
- A prediction can also end with `status` set to `failed`; the `error` field then explains why. Failed predictions are not billed.
- Retry 429, 500 and 503 responses with exponential backoff. Fix the input before retrying a 400.

## Implementation Guide
### Example Code

#### JavaScript
```javascript
const apiKey = "YOUR_API_MARKET_KEY";
const baseUrl = "https://prod.api.market/api/v1/magicapi/text-to-motion-generator-sprited-kimodo";

async function createAndWaitForPrediction(input) {
  const response = await fetch(`${baseUrl}/predictions`, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-api-market-key": apiKey
    },
    body: JSON.stringify({ version: "17111248e89aa145d768cc1e5f7baae228f69d854b996b860becfee287379545", input })
  });

  if (response.status !== 201) {
    throw new Error(`API error: ${response.status} ${await response.text()}`);
  }

  const prediction = await response.json();
  return pollForResults(prediction.id);
}

const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));

async function pollForResults(predictionId) {
  const maxTimeout = 900000;
  const pollInterval = 2000;
  const startTime = Date.now();

  while (Date.now() - startTime < maxTimeout) {
    const response = await fetch(`${baseUrl}/predictions/${predictionId}`, {
      headers: { "x-api-market-key": apiKey }
    });

    if (!response.ok) {
      throw new Error(`API error: ${response.status} ${await response.text()}`);
    }

    const prediction = await response.json();

    if (prediction.status === "succeeded") {
      return prediction.output;
    }

    if (prediction.status === "failed" || prediction.status === "canceled") {
      throw new Error(`Prediction ${prediction.status}: ${prediction.error || "Unknown error"}`);
    }

    await delay(pollInterval);
  }

  throw new Error("Prediction timed out after 15 minutes");
}

createAndWaitForPrediction({
  "seed": 42,
  "model": "Kimodo-SOMA-RP-v1.1",
  "prompt": "A person performs jumping jacks, repeatedly spreading both legs and raising both arms overhead, then returning to a standing position.",
  "preview": true,
  "duration": 3.5,
  "image_size": 512,
  "num_samples": 1,
  "postprocess": true,
  "diffusion_steps": 100
}).then((output) => console.log(output));
```

#### Python
```python
import time
import requests

API_KEY = "YOUR_API_MARKET_KEY"
BASE_URL = "https://prod.api.market/api/v1/magicapi/text-to-motion-generator-sprited-kimodo"


def create_and_wait_for_prediction(input_data):
    headers = {"Content-Type": "application/json", "x-api-market-key": API_KEY}
    response = requests.post(
        f"{BASE_URL}/predictions",
        headers=headers,
        json={"version": "17111248e89aa145d768cc1e5f7baae228f69d854b996b860becfee287379545", "input": input_data},
    )

    if response.status_code != 201:
        raise Exception(f"API error: {response.status_code} {response.text}")

    return poll_for_results(response.json()["id"])


def poll_for_results(prediction_id):
    max_timeout = 900
    poll_interval = 2
    headers = {"x-api-market-key": API_KEY}
    start_time = time.time()

    while time.time() - start_time < max_timeout:
        response = requests.get(f"{BASE_URL}/predictions/{prediction_id}", headers=headers)

        if response.status_code != 200:
            raise Exception(f"API error: {response.status_code} {response.text}")

        prediction = response.json()

        if prediction["status"] == "succeeded":
            return prediction["output"]

        if prediction["status"] in ("failed", "canceled"):
            raise Exception(f"Prediction {prediction['status']}: {prediction.get('error') or 'Unknown error'}")

        time.sleep(poll_interval)

    raise Exception("Prediction timed out after 15 minutes")


output = create_and_wait_for_prediction({
    "seed": 42,
    "model": "Kimodo-SOMA-RP-v1.1",
    "prompt": "A person performs jumping jacks, repeatedly spreading both legs and raising both arms overhead, then returning to a standing position.",
    "preview": True,
    "duration": 3.5,
    "image_size": 512,
    "num_samples": 1,
    "postprocess": True,
    "diffusion_steps": 100
})
print(output)
```

## FAQ
- **How do I chain several movements?**
  - Separate them with periods in `prompt`, for example "A person walks forward. The person sits down." Each segment lasts `duration` seconds, or set one duration per segment in `segment_durations` as a JSON array.
- **Which file formats can I get?**
  - GLB (default), BVH, NPZ or FBX, or `all` for every format. Set `output_delivery` to `bundle` to get them in one ZIP.
- **Can I apply the motion to my own character?**
  - Yes, for FBX export with SOMA models: send a Mixamo-rigged FBX character in `custom_fbx`.
- **What is in the preview?**
  - With `preview` on (default), the output includes an MP4 video of the motion for the sample chosen by `sample_index`.
- **What if my prediction fails?**
  - Failed predictions are not billed. Read the `error` field, adjust the input and try again.

## Contact Us
If you have any questions, reach out to us through the chat on the bottom right of the page. You can also email our support team at hello@magicapi.com.


Turn text descriptions into 3D character animations with NVIDIA Kimodo: sequential motions, constraints, several samples and GLB, BVH, NPZ or FBX export.