@oryksa/react-native

Official React Native SDK for ORYKSA AI Employees. Put an AI employee that already knows your business inside your iOS and Android app (React Native or Expo): a ready chat with the same look as the ORYKSA website chat, the name and photo of your AI from your ORYKSA account, in English, Portuguese (Portugal and Brazil) and Spanish.

• Docs: https://developer.oryksa.com/en/sdks
• API: https://api.oryksa.com/v1
• No native code: works in Expo Go.

Install

npm install @oryksa/react-native

What it is for

The SDK puts the ORYKSA chat and voice inside your app to serve the customers of your business: they ask, buy and book. The AI answers with your Brain, products and 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. It is not an interface for the owner: nobody changes settings, reads Activities or gives orders to ORYKSA through the SDK. More: https://help.oryksa.com/en/a/sdks-what-they-do

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

Voice and app context (1.1)

The chat shows a microphone when your plan has voice. It opens the voice screen with the same behaviour as the ORYKSA app: the microphone stays open while she speaks and only a human voice cuts her off (typing, TV and her own echo do not); she stops on the word and the text stays in the chat; a whisper gets a whispered answer; if her voice fails, the text is shown (never a robot voice).

Voice needs three native libraries (optional peer dependencies) and the microphone permission (Android RECORD_AUDIO, iOS NSMicrophoneUsageDescription):

npm install react-native-live-audio-stream react-native-sound react-native-fs

Without them the chat works and the microphone is hidden. Expo or another audio stack: pass your own audio adapter (startMic, stopMic, play, stopPlayback).

Each reply of the AI has a copy button under it. It uses @react-native-clipboard/clipboard when installed (optional peer dependency: npm install @react-native-clipboard/clipboard); older React Native versions use the built-in Clipboard.

<OryksaChatButton client={client} lang="pt"
  appContext={() => ({ screen: "product", title: "Sky Beginner Snowboard, 489.95" })} />

How it works (and why the key stays safe)

1. Your server keeps the secret API key (oryk_live_..., created at developer.oryksa.com) and creates a short-lived session token for each signed-in user with POST /v1/sessions (with @oryksa/sdk on Node: oryksa.createSession(...)).
2. Your app receives only that session token (oryk_cs_...). The secret key never goes into the app.
3. Every AI reply counts as one interaction of your ORYKSA plan, the same as on WhatsApp.

In the app

import { OryksaClient, OryksaChatButton } from "@oryksa/react-native";

const client = new OryksaClient({
  getToken: async () => (await fetch("https://your-server.example/oryksa-token").then((r) => r.json())).token,
});

export default function App() {
  return (
    <View style={{ flex: 1 }}>
      <MyScreens />
      <OryksaChatButton client={client} lang="en" /> {/* en, pt, br, es */}
    </View>
  );
}

Other pieces:

• <OryksaChatModal client={client} visible={open} onClose={() => setOpen(false)} />: open the chat from your own button.
• <OryksaChat client={client} />: the panel inside any screen.
• theme={{ accent: "#5B57E0" }}: colors.
• Without the UI: await client.agent(), await client.sendAndWait("Are you open on Saturday?"), await client.messages().

Keep the AI in sync with your app

On your server, with @oryksa/sdk:

await oryksa.learnApp({ name: "FitTrack", description: "...", screens: [...], faq: [...] });

Errors

Failed calls throw OryksaError with status, code (for example interaction_limit_reached, rate_limited, plan_required) and message.

Português (Portugal)

SDK oficial de React Native da ORYKSA AI Employees: põe na tua app iOS e Android um colaborador de IA que já conhece o teu negócio, com um chat pronto igual ao chat do site da ORYKSA, com o nome e a foto da tua IA.

1. O teu servidor guarda a chave secreta e cria um token de sessão para cada utilizador (POST /v1/sessions).
2. A app usa só esse token: new OryksaClient({ getToken }) e <OryksaChatButton client={client} lang="pt" />.
3. Cada resposta da IA conta como uma interação do teu plano.

Português (Brasil)

SDK oficial de React Native da ORYKSA AI Employees: coloque no seu app iOS e Android um colaborador de IA que já conhece o seu negócio, com um chat pronto igual ao chat do site da ORYKSA, com o nome e a foto da sua IA.

1. Seu servidor guarda a chave secreta e cria um token de sessão para cada usuário (POST /v1/sessions).
2. O app usa só esse token: new OryksaClient({ getToken }) e <OryksaChatButton client={client} lang="br" />.
3. Cada resposta da IA conta como uma interação do seu plano.

Español

SDK oficial de React Native de ORYKSA AI Employees: pon en tu app iOS y Android un empleado de IA que ya conoce tu negocio, con un chat listo igual al chat de la web de ORYKSA, con el nombre y la foto de tu IA.

1. Tu servidor guarda la clave secreta y crea un token de sesión para cada usuario (POST /v1/sessions).
2. La app usa solo ese token: new OryksaClient({ getToken }) y <OryksaChatButton client={client} lang="es" />.
3. Cada respuesta de la IA cuenta como una interacción de tu plan.

About the author

Weslley Harakawa - Founder of ORYKSA AI. Based in Lisbon, Portugal. Specialties: artificial intelligence, web and mobile development, blockchain tokenization. Education: University of the People.

• Website: https://harakawa.tech
• LinkedIn: https://www.linkedin.com/in/weslleyharakawa/
• Instagram: https://www.instagram.com/weslley.harakawa
• ORYKSA AI Employees: https://oryksa.com (X: https://x.com/oryksa, Instagram: https://www.instagram.com/oryksaai, YouTube: https://www.youtube.com/@ORYKSAAI)

MIT License · ORYKSA AI Employees · W8 Atlantic Unipessoal Lda