Node SDK Reference

This page documents every class, type, and utility exported by @orga-ai/node. Use it when you need the exact signatures for minting ephemeral tokens, fetching ICE servers, or keeping your API key locked to the backend.

Sections

• Classes — OrgaAI constructor, methods, and lifecycle controls.
• Types — OrgaAIConfig, SessionConfig, IceServer, and error type definitions.
• Errors — Exception hierarchy for authentication and server failures.

💡 Tip:
The Node SDK is the backbone for all client SDKs — it’s what your web and mobile apps call through your API route when they need ephemeral session credentials.

Structure

Each reference page covers:

1. A concise description of the class, interface, or constant.
2. Code examples in TypeScript/JavaScript.
3. Detailed parameter and return value tables.
4. Notes about error handling and configuration.

Runtime requirements

Related material

• Node tutorial – build the secure proxy endpoint.
• Node architecture explanation – placement within the broader system.
• React client reference – how frontends consume the proxy output.

Next steps

• Classes
• Types
• Errors