.NET SDK (desktop and servers)

ORYKSA for .NET apps on Windows, Linux and macOS, and for .NET backends: client, server helpers and webhook verification.

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

Install

The NuGet package Oryksa is being published; until it is listed, add the project from GitHub (git submodule or project reference).

dotnet add package Oryksa

Minimal example

Client side (desktop app): talk to the AI employee without a UI of its own. For a ready chat window on the desktop, show the website chat in a WebView2, or use the JavaScript SDK in Electron or 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}");

Server side (.NET backend): keep the API key on the server, create session tokens for your apps, teach the business and verify 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);

Pieces