API Overview
Welcome to the Orga Node SDK API Reference.
This section documents the classes, types, and utilities exported by @orga‑ai/node.
The Node SDK powers secure server‑side interactions with Orga Cloud — fetching short‑lived ephemeral credentials for client applications and preventing API key exposure in frontend code.
Sections
- Classes — Core SDK class
OrgaAIused to connect your backend to Orga Cloud. - Types — TypeScript definitions for request/response payloads, configuration shapes, and errors.
- Errors — Custom error classes for structured handling and error codes.
đź’ˇ 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:
- A concise description of the class, interface, or constant.
- Code examples in TypeScript/JavaScript.
- Detailed parameter and return value tables.
- Notes about error handling and configuration.
Development Environment Requirements
| Requirement | Details |
|---|---|
| Node.js ≥18 | Required for native fetch and AbortController. |
| Module system | Works with ESM or CommonJS (import or require). |
| Network access | Must allow outbound HTTPS to https://api.orga-ai.com. |
| Environment variables | ORGA_API_KEY (required), USER_EMAIL (required for now). |
| Dependencies | None beyond Node’s built‑in APIs. |
Versioning
The Node SDK follows semantic versioning (SemVer).
Breaking changes or required parameter updates will trigger a major version bump (1.x → 2.x).
Current release: v1.0.0-beta.1 (Open Beta)
For changelog and upgrade guidance, see Changelog.
Recommended Reading
If you’re implementing Orga end‑to‑end:
- Quick Start → Create your backend proxy route.
- Architecture → Understand how the SDK fits between clients and Orga Cloud.
- Client SDKs → See how frontends consume your proxy endpoint.