API Documentation

Supercharge your AI in the real world.

Reference for the RakuAI developer console REST API and the MCP runtime contract. REST endpoints are versioned under /api/v1/; the MCP server lives at api.rakuai.com/mcp/. 18 native DLLs, 17 router modules, 9,500+ REST endpoints, 10,328 bound engine functions — the boring numbers behind a fun-feeling runtime.

Why RakuAI? Multi-vendor by design — Claude, ChatGPT, Gemini, and Copilot all drive the same six-tool MCP surface. 18ms motion-to-photon, sub-millimeter spatial precision, OpenXR conformant. Unity’s MCP targets scene manipulation at design time; RakuAI’s runs at runtime, every frame.

Wiring up an AI assistant? Most developers want the Claude Desktop guide — the six MCP tools appear natively in your conversations after a one-time config. The REST endpoints below cover the developer console and key management.

Quick Start

The fastest path: wire the MCP server into Claude Desktop and call get_metrics. The two-step REST flow below is for programmatic access to the developer console.

1. Get an API Key

Accept the developer NDA and create an API key from the dashboard. The same key mints short-lived JWTs for the MCP server (see the Claude Desktop guide) and authorizes REST calls below.

2. Drive the Runtime over MCP

Once Claude Desktop is wired, ask:

Call get_metrics on the Raku runtime.

Claude invokes get_metrics and returns a JSON payload like:

            JSON
            {

              "fps": 0.0,

              "sim_running": false,

              "loaded_adapters": 0,

              "status": "ok"

            }

3. Call REST Endpoints Directly

For programmatic developer-console work (key management, usage, etc.), call the REST endpoints with your API key:

            cURL
            curl https://api.rakuai.com/api/v1/usage \

              -H "Authorization: Bearer YOUR_API_KEY"
        

Authentication

All API requests require a Bearer token in the Authorization header. You can use either a JWT access token (from login/register) or an API key (from the developer dashboard).

Authorization: Bearer <your_token_or_api_key>

MCP Server

MCP https://api.rakuai.com/mcp/

The six-tool MCP surface for driving the runtime from any MCP-capable client. Stdio and HTTP transports. Deny-by-default permissions per tool per caller; full audit log. See the Claude Desktop guide for wiring instructions and the full tool reference.

Tool	Mode	Description
`get_metrics`	all	FPS, frame time, adapter count, uptime — safe read.
`get_scene_state`	all	Snapshot of nodes, physics bodies, loaded adapters, sim state.
`load_world_model`	sandbox/dev	Register an adapter (Runway, Veo, Marble, Genie, content_pack).
`ingest_frame`	sandbox/dev	Push a frame from a generative model into the scene graph.
`set_render_target`	sandbox/dev	WebGL, VR headset, native window, or offscreen.
`start_simulation`	sandbox/dev	Begin the simulation loop. Denied in production mode by design.

GET /api/v1/usage

Get your generation and iteration counts, tier info, and remaining quota.

API Key Management

POST /api/v1/developer/keys

Create a new API key with specified scopes.

GET /api/v1/developer/keys

List all your API keys (active and revoked).

DELETE /api/v1/developer/keys/{key_id}

Revoke an API key. Cannot be undone.

Rate Limits

API requests are rate-limited per user tier:

Tier	Generations/day	Iterations/day	Concurrent
Anonymous	3	0	1
Free	10	30	1
Pro	100	500	3
Enterprise	Unlimited	Unlimited	10

Exceeded limits return 429 Too Many Requests with a Retry-After header.

Interactive API Explorer

Explore the full API interactively using the auto-generated documentation:

Swagger UI → Redoc →