ORYKSAORYKSADevelopers
Obter chaves de API

SDKs

O colaborador de IA da ORYKSA dentro da sua app: chat nativo, voz e um Brain que aprende a app.

O que o SDK faz e para que serve

Coloca no seu app o balão de chat e a voz da ORYKSA para atender os clientes da sua empresa: eles perguntam, compram e agendam. A IA responde com o seu Brain, os seus produtos e os seus serviços, com o nome, a foto e a voz que você escolheu em Sua IA, e registra leads, agendamentos e vendas nas Atividades da sua conta ORYKSA, como no WhatsApp ou no chat do site.

Não é uma interface do dono: pelo SDK ninguém altera as suas configurações, lê as suas Atividades ou dá ordens à ORYKSA, mesmo dizendo que é o dono. O chat em que o dono fala com a ORYKSA existe só no app ORYKSA oficial, no painel e na extensão do navegador.

Voz desde a versão 1.1 (Android, iOS, Flutter e React Native), com o mesmo comportamento do app ORYKSA. Os SDKs JavaScript e .NET são só texto.

Os palavrões que o cliente digita aparecem com asteriscos no chat (a mesma lista de todos os chats da ORYKSA, em GET https://app.oryksa.com/widget/profanity.json); as respostas da IA já vêm filtradas.

Saiba mais na Central de Ajuda

Os SDKs usam a API acima e acrescentam uma interface de chat pronta (com o mesmo visual do chat dos sites), para seus usuários conversarem com o colaborador de IA sem sair do app. Você passa a configuração e o conteúdo do app, e o SDK mantém o Brain do agente sincronizado para ele entender o app.

PlataformaPacoteEstado
JavaScript / TypeScript (web, Node, Electron)@oryksa/sdkDisponível: npm install @oryksa/sdk (npm, GitHub)
React Native@oryksa/react-nativeDisponível: npm install @oryksa/react-native (npm, GitHub, guia)
Flutteroryksa (pub.dev)Disponível: flutter pub add oryksa (GitHub, guia)
Android (Kotlin / Java)com.oryksa:sdkDisponível: Maven Central, JitPack (GitHub, guia)
iOS (Swift)Swift Package oryksa-swiftDisponível: Swift Package Manager (GitHub, guia); CocoaPods
Desktop Windows / Linux, servidores .NETOryksa (NuGet), SDK JavaScript em Electron ou TauriDisponível: GitHub (guia); listagem NuGet a seguir
Segurança de raiz. A chave de API fica no seu servidor. Os apps móveis e de desktop se comunicam com a ORYKSA através do seu backend ou de tokens de sessão de curta duração, nunca com a chave secreta dentro do pacote do app. Nas plataformas ainda sem SDK, chame a API REST a partir do seu backend: todos os exemplos desta documentação já funcionam hoje.