ORYKSAORYKSADevelopers
Obter chaves de API

SDK .NET (desktop e servidores)

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

O que o SDK faz e para que serve

Põe na tua app o balão de chat e a voz da ORYKSA para atender os clientes da tua empresa: perguntam, compram e marcam. A IA responde com o teu Brain, os teus produtos e os teus serviços, com o nome, a foto e a voz que escolheste em A tua IA, e grava leads, marcações e vendas nas Atividades da tua conta ORYKSA, como no WhatsApp ou no chat do site.

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

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

Os palavrões que o cliente escreve 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.

Saber mais no Centro de Ajuda

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

Instalar

O pacote NuGet Oryksa está a ser publicado; até estar listado, adiciona 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): fala com o colaborador de IA sem interface própria. Para uma janela de chat pronta no desktop, mostra o chat do site num WebView2, ou usa 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 as tuas 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 esperar 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 de raiz. Nunca ponhas a chave secreta no pacote da app. Usa o getToken para ir buscar ao teu backend um token oryk_cs_... de curta duração; o SDK renova-o quando expira. Cria os tokens com a API de sessões a partir de qualquer linguagem de servidor.