Android SDK (Kotlin)

The ORYKSA AI employee inside an Android app: Jetpack Compose or Views, the same chat as the website, in four languages.

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

Available on Maven Central (com.oryksa:sdk:1.1.1) and on JitPack.

// build.gradle.kts (app): Maven Central is in the default repositories
implementation("com.oryksa:sdk:1.1.1")

// Alternative, JitPack:
// settings.gradle.kts -> repositories { maven("https://jitpack.io") }
// implementation("com.github.oryksa:oryksa-android:1.1.1")

Minimal example

A button that opens the chat activity. The chat shows the AI employee's name and photo, exactly like the website chat.

import com.oryksa.sdk.*

// The app never holds the API key: your backend creates short-lived
// session tokens (oryk_cs_...) with POST /v1/sessions and hands them over.
val client = OryksaClient(getToken = { myBackend.fetchOryksaToken() })
OryksaChatActivity.client = client

@Composable
fun MyScreen() {
    val context = LocalContext.current
    OryksaChatButton(client = client, onClick = {
        OryksaChatActivity.open(context, lang = "en")   // en, pt, br, es
    })
}

// Apps with Views: OryksaChatActivity.open(this, "en")

Pieces

What the user sees

• The same look as the website chat: button with the photo, header with the name and "online", bubbles, suggestions, SEND and "Powered by ORYKSA".
• Languages: en, pt (Portugal), br (Brazil), es. The name and photo come from the owner's "Your AI" profile.
• Voice (since 1.1): the microphone in the chat opens the voice screen, with the same behaviour as the ORYKSA app. Each reply has a copy button.