oryksa_server library
ORYKSA server helpers: ONLY for the subscriber's own backend (Dart servers such as shelf, dart_frog or serverpod). Never import this library in a Flutter app.
- Oryksa: server client with the SECRET API key (
oryk_live_...): session tokens for the app (Oryksa.createSession) and the calls that change the AI and its Brain (Oryksa.updateAgent, Oryksa.setPages, Oryksa.addFaq, Oryksa.learnApp). - verifyWebhook: checks the signature of ORYKSA webhooks.
The app library (package:oryksa/oryksa.dart) serves the customers of the business
only and does not include any of this.
Classes
- Oryksa
-
Server client for Dart backends (shelf, dart_frog, serverpod...). Uses the SECRET
API key (
oryk_live_...). Never put the key inside a Flutter app: in the app use OryksaClient with a session token created here with createSession. - OryksaAgent
- Public look of the AI employee (the same data the ORYKSA website chat shows).
- OryksaAppContext
- Where the customer is inside your app. Sent with each message so the AI knows the current screen (for example a product page) and answers about it.
- OryksaMessage
- One message of the conversation.
- OryksaReply
-
Answer of
send:repliedwith the text, orpendingwhile the AI is still writing.
Functions
-
verifyWebhook(
String rawBody, String? signatureHeader, String secret, {Duration tolerance = const Duration(minutes: 5)}) → Map< String, dynamic> -
Verifies an ORYKSA webhook (for Dart backends). Pass the RAW body and the
ORYKSA-Signatureheader. Returns the parsed event or throws OryksaException.
Exceptions / Errors
- OryksaException
- Error returned by the ORYKSA API.