> For the complete documentation index, see [llms.txt](https://animotive.gitbook.io/animotive-kimodo/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://animotive.gitbook.io/animotive-kimodo/setup/animotive-backend.md).

# Animotive Kimodo (Hosted)

Animotive Kimodo is the managed cloud generation service. Zero local setup — no Docker, no FastAPI server, no GPU required on your machine. Generations run on Animotive's hosted deployment and are billed against the token balance on your account.

## What you'll need

* An Animotive account.
* An API key issued from your account portal.

## Quick setup

1. Open **Edit → Project Settings → Plugins → Kimodo Exporter**.
2. Set **Active Backend** to **Animotive**.
3. Paste your API key into the **Animotive Kimodo** section's **Animotive API Key** field.
4. Click **Test API Key** to confirm the key is accepted before you generate (see below).

Returned BVH files land automatically in `<Project>/Saved/Kimodo/Exports` — there is nothing to configure. (The **Export Directory** setting only applies to the Docker backend, so it is hidden for Animotive.)

The same fields are surfaced in the **First-Run Setup** popup (auto-opens on first editor session; reopen via **Tools → Animotive Kimodo → First-Run Setup**). The popup includes a **Get API Key** link that opens the Animotive portal in a browser, and a **Test API Key** button beside the API Key field.

## Test API Key

Both the **First-Run Setup** popup and **Project Settings → Plugins → Kimodo Exporter** place a **Test API Key** button next to the Animotive API Key field. It validates the key you've entered against the hosted service (`GET /v1/get-user-info`) without requiring you to save first.

While the check runs the button is disabled and the inline status reads **Checking…**. On completion it shows one of:

* **✓ Valid — N credits** — the key is accepted; `N` is your current balance.
* **✗ Invalid API key** — the server rejected the key (HTTP 401 / 403). Re-copy it from your account portal.
* **✗ Couldn't verify: …** — a network or server error prevented the check (the reason follows). The key may still be fine; try again.

The button is disabled while the key field is empty.

## How a generation flows

Once Animotive is the active backend:

1. **Generate with Kimodo** in the Sequencer toolbar submits the export via HTTPS to `https://kimodo-middleware.animotive.com/v1/generate` with your API key as a Bearer token.
2. The service returns a job identifier and a WebSocket URL.
3. The plugin connects to the WebSocket over WSS and streams progress events into the **Kimodo Monitor** panel — the same monitor row UI used for the local and self-hosted backends.
4. On completion, the result BVH is fetched over HTTPS, written to `<Project>/Saved/Kimodo/Exports`, auto-imported, and retargeted onto your character per the standard round-trip pipeline.

No service-URL configuration is required on your end — the endpoint is built into the plugin.

## When a generation is rejected

If the Animotive service rejects an export (any non-2xx response), the shared **export error modal** explains what went wrong. It shows:

* a friendly one-line summary of the failure category, and
* the **raw server response** verbatim, under a **Server response:** heading, in a scrollable, selectable box, with a **Copy** button so you can paste it into a support request.

Two common cases are account problems and get the title **Animotive Kimodo — Account Problem** plus a tailored summary:

* **Insufficient tokens** (HTTP 402 / 403): *Your Animotive token balance is insufficient.* The modal includes a **Find out more at kimodo.animotive.com** link. The Monitor row carries the `InsufficientTokens` category.
* **Invalid API key** (HTTP 401): *Your Animotive API key was rejected.* Re-check the key in settings, or use **Test API Key**. The Monitor row carries the `InvalidApiKey` category.

Other server-side rejections use the generic title **Kimodo Export — Couldn't Complete This Request**. The modal is additive — the **Kimodo Monitor** row for the failed export still transitions to **Failed** with the matching category and friendly text. See [Troubleshooting → Export error modal](/animotive-kimodo/going-further/troubleshooting.md#export-error-modal) for the full list of situations that raise it.

Each generation consumes tokens against your account balance; manage your balance in the [Animotive account portal](https://kimodo.animotive.com/).

## Monitor status strip

When Animotive is the active backend, the **Kimodo Monitor** panel surfaces a status strip at the top:

* If your API key is **empty**, the strip shows a short message explaining the backend is not yet configured.
* If your API key is **set**, the strip shows your current **credit balance** (see below).

The strip also carries an **Open Settings** link (jumps to the Kimodo Exporter project-settings panel) and a **Get API Key** link (opens the Animotive portal). The strip is hidden for the Docker and Remote Server backends.

## Credit balance display

Your available credits are shown in-editor when Animotive is the active backend and an API key is set. The plugin reads them from the hosted service (`GET /v1/get-user-info`) using your API key, and displays them in three places:

* **Kimodo Monitor** panel — in the status strip at the top, e.g. `0 credits`.
* **Kimodo Assistant** panel — on the footer line above the **Generate** button.
* **Project Settings → Plugins → Kimodo Exporter** — a read-only **Credit Balance** field in the **Animotive Kimodo** section, with a **Refresh Credit Balance** button beside it.

The balance refreshes automatically when a credit panel opens and after each generation finishes (so spent credits are reflected). The settings field also updates on the **Refresh Credit Balance** button. If the balance can't be loaded (empty/invalid key or a network error) the display shows `—` or a short "couldn't load credits" message. The figure is read-only here — purchase or manage credits in your [Animotive account portal](https://kimodo.animotive.com/).

## See also

* [First-Run Setup Popup](/animotive-kimodo/setup/first-run-setup.md) — the in-editor configuration window covering all three backends.
* [Self-Hosted (HTTP) Backend](/animotive-kimodo/setup/remote-backend.md) — distinct from Animotive: same HTTP transport, different endpoint + body envelope + 202 response shape, no built-in billing.
* [Local (Docker) Backend](/animotive-kimodo/setup/docker-local.md) — runs on your own GPU; no cloud calls.
* [Troubleshooting](/animotive-kimodo/going-further/troubleshooting.md) — common Animotive errors (auth failure, token exhaustion, service unavailable).