ORYKSAORYKSADevelopers
Get API keys

SDKs

The ORYKSA AI employee inside your app: native chat, voice and a Brain that learns the app.

What the SDK does and what it is for

It puts the ORYKSA chat bubble and voice inside your app, to serve the customers of your business: they ask, buy and book. The AI answers with your Brain, your products and your services, with the name, photo and voice you chose in Your AI, and saves leads, bookings and sales in the Activities of your ORYKSA account, like WhatsApp or the website chat.

It is not an interface for the owner: through the SDK nobody changes your settings, reads your Activities or gives orders to ORYKSA, even if they say they are the owner. The chat where the owner talks to ORYKSA exists only in the official ORYKSA app, the dashboard and the browser extension.

Voice since version 1.1 (Android, iOS, Flutter and React Native), with the same behaviour as the ORYKSA app. The JavaScript and .NET SDKs are text only.

Swear words the customer types show as asterisks in the chat (the same list as every ORYKSA chat, from GET https://app.oryksa.com/widget/profanity.json); the AI's replies already come filtered.

Read more in the Help Center

The SDKs wrap the API above and add a ready-made chat UI (the same look as the website chat), so your users can talk to the AI employee without leaving the app. You pass the app's configuration and content, and the SDK keeps the agent's Brain in sync so it understands the app.

PlatformPackageStatus
JavaScript / TypeScript (web, Node, Electron)@oryksa/sdkAvailable: npm install @oryksa/sdk (npm, GitHub)
React Native@oryksa/react-nativeAvailable: npm install @oryksa/react-native (npm, GitHub, guide)
Flutteroryksa (pub.dev)Available: flutter pub add oryksa (GitHub, guide)
Android (Kotlin / Java)com.oryksa:sdkAvailable: Maven Central, JitPack (GitHub, guide)
iOS (Swift)Swift Package oryksa-swiftAvailable: Swift Package Manager (GitHub, guide); CocoaPods
Desktop Windows / Linux, .NET serversOryksa (NuGet), JavaScript SDK in Electron or TauriAvailable: GitHub (guide); NuGet listing next
Security by design. The API key stays on your server. Mobile and desktop apps talk to ORYKSA through your backend or through short-lived session tokens, never with the secret key inside the app bundle. For platforms without an SDK yet, call the REST API from your backend: every example in this documentation works today.