XRift SDK Guide

A guide for using @xrift/sdk to programmatically interact with the XRift platform API.

References

• API Reference - Full specification of XriftClient, WorldsApi, ItemsApi, error classes, and utility functions
• Code Templates - Ready-to-use code examples for Node.js and browser environments
• Type Definitions - Complete TypeScript type definitions for all SDK interfaces

Critical Rules

1. API token is always required — XriftClient must be initialized with a valid token. Never hardcode tokens; use environment variables or secure configuration.
2. File data must be FileData type — The SDK accepts ArrayBuffer | Uint8Array, not file paths or strings. The caller is responsible for reading files into binary data before passing to the SDK.
3. remotePath must be a relative path — Never use absolute paths or paths starting with /. Use paths like scene.glb or assets/texture.png.
4. Always handle errors — Wrap API calls in try/catch and handle XriftAuthError, XriftApiError, and XriftNetworkError separately.

Project Overview