ORYKSAORYKSADevelopers
Obter chaves de API

SDK .NET (desktop e servidores)

ORYKSA para apps .NET no Windows, Linux e macOS, e para backends .NET: cliente, auxiliares de servidor e verificação de webhooks.

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

PacoteVersãoPlataformasLicença
Oryksa (GitHub)1.0.0netstandard2.0, net8.0MIT

Instalar

O pacote NuGet Oryksa está sendo publicado; até ele aparecer na listagem, adicione o projeto a partir do GitHub (submódulo git ou referência de projeto).

dotnet add package Oryksa

Exemplo mínimo

Lado do cliente (app desktop): fale com o colaborador de IA sem interface própria. Para uma janela de chat pronta no desktop, mostre o chat do site em um WebView2, ou use o SDK JavaScript em Electron ou Tauri.

using Oryksa;

// The app never holds the API key: your backend creates short-lived
// session tokens (oryk_cs_...) with POST /v1/sessions and hands them over.
var client = new OryksaClient(getToken: async ct => await MyBackend.FetchOryksaTokenAsync(ct));

var agent = await client.AgentAsync();                                   // name and photo of the AI
var reply = await client.SendAndWaitAsync("Are you open on Saturday?");  // one question, one answer
Console.WriteLine($"{agent.Name}: {reply.Text}");

Lado do servidor (backend .NET): a chave de API fica no servidor, cria tokens de sessão para os seus apps, ensina o negócio e verifica webhooks.

using Oryksa;

var oryksa = new OryksaServer(Environment.GetEnvironmentVariable("ORYKSA_API_KEY")!);
var session = await oryksa.CreateSessionAsync(visitor: "user_42", lang: "pt");   // -> oryk_cs_...
await oryksa.SetPagesAsync(pages);        // teaches the business (Knowledge API)
await oryksa.AddFaqAsync(question, answer);
var ok = OryksaWebhook.Verify(rawBody, signatureHeader, secret);

Peças

PeçaO que faz
OryksaClient: AgentAsync(), SendAndWaitAsync(text), MessagesAsync()Dados do agente (nome, foto), enviar uma mensagem e aguardar a resposta, histórico de mensagens.
OryksaServer: CreateSessionAsync(), SetPagesAsync(), AddFaqAsync()Tokens de sessão, páginas e FAQs para o Brain.
OryksaWebhook.Verify()Verificação da assinatura dos webhooks.
Segurança desde a base. Nunca coloque a chave secreta no pacote do app. Use o getToken para buscar no seu backend um token oryk_cs_... de curta duração; o SDK renova o token quando ele expira. Crie os tokens com a API de sessões a partir de qualquer linguagem de servidor.