API Reference

Build with ZeroWeight using a simple public API for avatar runtime bundles and LiveKit session tokens.

Base URL: https://api.zeroweight.ai

The ZeroWeight Public API lets you:

Overview

ZeroWeight uses API keys for all public API requests.

Send your API key in this header:

X-ZW-Api-Key: <your-api-key>

Always send your API key from a trusted backend environment. Do not expose secret keys in the client if your setup does not require it.

API keys are managed in the ZeroWeight Dashboard and scoped to a specific user.

All /api/v1/* routes are rate-limited by client IP.

Limit	Remaining header	Error when exceeded
200 requests per minute	`X-RateLimit-Remaining`	`429 Too Many Requests`

Fetch the encrypted runtime bundle for a specific avatar.

This bundle contains the assets and configuration needed to render the avatar on the client side.

Name	Type	Required	Description
`avatar_id`	`string`	Yes	Unique avatar identifier

curl -H "X-ZW-Api-Key: <your-api-key>" \
  "https://api.zeroweight.ai/api/v1/avatars/bundle/avatar_123"

{
  "payload": "<encrypted-payload-string>"
}

Generate a temporary LiveKit JWT for connecting a client to a real-time room for a specific avatar.

Name	Type	Required	Description
`avatar_id`	`string`	Yes	Target avatar UID
`name`	`string`	No	User display name. Default: `"my name"`
`room`	`string`	No	Specific room ID. Auto-generated if omitted

curl -H "X-ZW-Api-Key: <your-api-key>" \
  "https://api.zeroweight.ai/api/v1/livekit/getToken?avatar_id=avatar_123&name=alice"

{
  "token": "<livekit-jwt-token>",
  "room_name": "unique-room-id-456"
}

The API returns standard HTTP status codes. Errors usually follow this format:

{
  "detail": "Error message"
}

{
  "detail": "Invalid API key"
}

{
  "detail": "Avatar is no longer available"
}

{
  "detail": "Avatar not found"
}

{
  "detail": "Rate limit exceeded"
}