# Spatius

## Docs

- [Agora Convo AI Client](https://docs.spatius.ai/agora-convoai/client.md): Use AvatarKit RTC clients with AgoraProvider.
- [Agora Convo AI Agent](https://docs.spatius.ai/agora-convoai/convo-ai-agent.md): Configure Spatius as an avatar provider for Agora Convo AI.
- [Agora Convo AI Integration](https://docs.spatius.ai/agora-convoai/overview.md): Use Agora Convo AI and Spatius to build voice avatars.
- [TEN Framework Extension](https://docs.spatius.ai/agora-convoai/ten-extension.md): Configure spatius_avatar_python when you run a TEN Framework graph directly.
- [Session Token API](https://docs.spatius.ai/api-reference/api-reference.md): Console API endpoint for issuing Spatius Session Tokens.
- [Session Token Auth Flow](https://docs.spatius.ai/api-reference/auth.md): How Direct Mode clients obtain and use Spatius Session Tokens without exposing backend API Keys.
- [Spatius API Authentication](https://docs.spatius.ai/api-reference/authentication.md): Authenticate Spatius API requests with the X-App-ID and X-API-Key header pair.
- [Get an Avatar job](https://docs.spatius.ai/api-reference/avatar-jobs/get-an-avatar-job.md): Returns a single Avatar creation job. Poll this endpoint after `POST /avatars` until `status` is `succeeded` (use `avatarId`) or `failed` (inspect `error`). A polling interval of 5-10 seconds is recommended.
- [List Avatar jobs](https://docs.spatius.ai/api-reference/avatar-jobs/list-avatar-jobs.md): Returns the Avatar creation jobs submitted by the authenticated account, newest first. Use the `statuses` query parameter to filter by job status.
- [Create an Avatar](https://docs.spatius.ai/api-reference/avatars/create-an-avatar.md): Accepts a source image URL and queues an asynchronous Avatar creation job. Spatius downloads and validates the image, preprocesses it, and generates the Avatar through the Studio pipeline. Poll `GET /avatar-jobs/{jobId}` until the job reaches `succeeded` or `failed`.
- [Get an Avatar](https://docs.spatius.ai/api-reference/avatars/get-an-avatar.md): Returns a single Studio Avatar owned by the authenticated account.
- [List Avatars](https://docs.spatius.ai/api-reference/avatars/list-avatars.md): Returns the Studio avatars owned by the authenticated account, including avatars created through the Spatius API and through Spatius Studio. Results are paginated.
- [Spatius API Errors and Limits](https://docs.spatius.ai/api-reference/errors.md): Spatius API error envelope, HTTP status mapping, avatar job failure codes, and per-account rate limits.
- [Spatius API](https://docs.spatius.ai/api-reference/overview.md): Access and manage resources in Spatius Studio programmatically.
- [Regions](https://docs.spatius.ai/api-reference/regions.md): Supported Spatius regions, endpoint composition, credential portability, and advanced endpoint override notes.
- [Backend Mode Client SDK](https://docs.spatius.ai/backend-mode/client-sdk.md): Use AvatarKit clients to render messages produced by your Backend Mode.
- [Backend Mode Integration](https://docs.spatius.ai/backend-mode/overview.md): Your backend owns the audio pipeline and downstream transport.
- [Backend Mode with your own transport](https://docs.spatius.ai/backend-mode/own-transport.md): Backend Mode Integration where your backend relays encoded audio payloads and motion data payloads directly to clients.
- [Backend Mode Server SDK](https://docs.spatius.ai/backend-mode/server-sdk.md): Use the Server SDK on your backend to connect to Motion Server.
- [Backend Mode with LiveKit](https://docs.spatius.ai/backend-mode/with-livekit.md): Use a LiveKit room as the RTC transport between a Backend Mode pipeline and a Web client.
- [Audio](https://docs.spatius.ai/concepts/audio.md): Audio input rules for Spatius: source timing, PCM format, buffering, interruption, and lip-sync guidance.
- [Avatar](https://docs.spatius.ai/concepts/avatar.md): Avatar IDs, avatar assets, loading, caching, and how AvatarKit uses the digital-human resource.
- [Avatar Background](https://docs.spatius.ai/concepts/avatar-background.md): Download the optional 16:9 Avatar background from Spatius Studio and render it behind AvatarKit in your app.
- [How It Works](https://docs.spatius.ai/concepts/how-it-works.md): Spatius architecture: Motion Server receives avatar speech audio, returns motion data, and AvatarKit renders locally.
- [Client Lifecycle](https://docs.spatius.ai/concepts/lifecycle.md): The AvatarKit client lifecycle: initialize, load avatar assets, render, authenticate, connect, interact, and clean up.
- [Client State & Events](https://docs.spatius.ai/concepts/state-events.md): AvatarKit client state callbacks, including ConversationState, ConnectionState, error events, and recovery context.
- [Direct Mode Integration for Android](https://docs.spatius.ai/direct-mode/android.md): Use the Android AvatarKit SDK to connect directly to Motion Server with a Session Token.
- [Direct Mode Integration for Flutter](https://docs.spatius.ai/direct-mode/flutter.md): Use the Spatius Flutter package to connect directly to Motion Server with a Session Token.
- [Direct Mode Integration for iOS](https://docs.spatius.ai/direct-mode/ios.md): Use the iOS AvatarKit SDK to connect directly to Motion Server with a Session Token.
- [Direct Mode Integration](https://docs.spatius.ai/direct-mode/overview.md): Your client connects directly to Motion Server using a Session Token.
- [Direct Mode Integration for Web](https://docs.spatius.ai/direct-mode/web.md): Use the Web client SDK to connect directly to Motion Server with a Session Token.
- [Credentials](https://docs.spatius.ai/getting-started/credentials.md): App ID, Avatar ID, API Key, and Session Token — who issues each and where each is used.
- [Developer Docs Map](https://docs.spatius.ai/getting-started/docs-map.md): A structured map of Spatius guides, integration paths, SDK references, Spatius API pages, Session Token API pages, regions, and troubleshooting pages.
- [Choose Your Integration Path](https://docs.spatius.ai/getting-started/how-to-integrate.md): Pick a Platform Integration or a Standalone Integration based on whether you build on a third-party agent platform.
- [Welcome to Spatius](https://docs.spatius.ai/getting-started/introduction.md): What Spatius is, the core components, and how to start integrating.
- [LiveKit Agents Integration Client](https://docs.spatius.ai/livekit-agents/client.md): Use the AvatarKit RTC client in a LiveKit Agents Integration.
- [LiveKit Agents Integration](https://docs.spatius.ai/livekit-agents/overview.md): Use LiveKit Agents and Spatius to build voice avatars.
- [LiveKit Agents Integration Server](https://docs.spatius.ai/livekit-agents/server.md): Use livekit-plugins-spatius in a LiveKit Agents worker.
- [Android SDK Quickstart](https://docs.spatius.ai/quickstarts/android-sdk.md): Run the Android Direct Mode sample with AvatarKit.
- [Flutter SDK Quickstart](https://docs.spatius.ai/quickstarts/flutter-sdk.md): Run the Flutter Direct Mode sample with AvatarKit.
- [iOS SDK Quickstart](https://docs.spatius.ai/quickstarts/ios-sdk.md): Run the iOS Direct Mode sample with AvatarKit.
- [LiveKit Agents Integration Quickstart](https://docs.spatius.ai/quickstarts/livekit-agents.md): Build a voice avatar with Spatius, LiveKit Agents, and Gemini Live in 5 minutes.
- [Quickstarts](https://docs.spatius.ai/quickstarts/overview.md): First-run guide for Direct Mode SDK quickstarts, platform integration first runs, token endpoints, and demo selection.
- [Web SDK Quickstart](https://docs.spatius.ai/quickstarts/web-sdk.md): Run the Direct Mode Web quickstart with sample audio first, then optional realtime conversation.
- [Reference Overview](https://docs.spatius.ai/reference/overview.md): A lookup map for Spatius Client SDKs, Server SDKs, Session Token API pages, regions, endpoints, and error codes.
- [SDK Capability Matrix](https://docs.spatius.ai/reference/sdk-capabilities.md): Documented Spatius SDK capability matrix across Web, iOS, Android, Flutter, Python Server SDK, and Go Server SDK.
- [Client Error Codes](https://docs.spatius.ai/resources/client-error.md): Web, iOS, Android, and Flutter SDK error codes with recovery guidance
- [Demo Projects](https://docs.spatius.ai/resources/demo-projects.md): Runnable end-to-end examples mapped by platform and integration path.
- [FAQ](https://docs.spatius.ai/resources/faq.md): Common product and integration questions from developer Q&A.
- [Server Error Codes](https://docs.spatius.ai/resources/server-error.md): Stable server-side SDK error codes and handling fields
- [Android SDK Reference](https://docs.spatius.ai/sdk-reference/android-sdk/api-reference.md): Browse the Android AvatarKit SDK API reference.
- [AvatarKit Flutter SDK Reference](https://docs.spatius.ai/sdk-reference/flutter-sdk/api-reference.md): AvatarKit Flutter SDK reference for Direct Mode, Backend Mode client feed, state callbacks, and demos.
- [Golang SDK](https://docs.spatius.ai/sdk-reference/go-sdk/go-sdk.md): Go Server SDK reference for Backend Mode sessions, audio input, callbacks, LiveKit egress, options, and errors.
- [iOS SDK Reference](https://docs.spatius.ai/sdk-reference/ios-sdk/api-reference.md): Browse the iOS AvatarKit SDK API reference.
- [Python SDK](https://docs.spatius.ai/sdk-reference/python-sdk/python-sdk.md): Python Server SDK reference for Backend Mode sessions, audio input, motion data callbacks, egress modes, and errors.
- [AvatarKit UI](https://docs.spatius.ai/sdk-reference/web-sdk/avatarkit-ui.md): Spatius avatar components for React.
- [AvatarKit Web SDK Reference](https://docs.spatius.ai/sdk-reference/web-sdk/reference.md): Complete API reference for @spatius/avatarkit (Web).
- [RTC Adapter](https://docs.spatius.ai/sdk-reference/web-sdk/rtc-adapter.md): Use @spatius/avatarkit-rtc as the Web transport adapter for LiveKit and Agora RTC providers.
- [Toolchain Setup](https://docs.spatius.ai/sdk-reference/web-sdk/toolchain.md): Configure your web build tool to load AvatarKit WebAssembly assets

## OpenAPI Specs

- [avatar-open-api](https://docs.spatius.ai/openapi/avatar-open-api.json)
- [openapi](https://docs.spatius.ai/api-reference/openapi.json)