User Guide

← Back to Docs

📖 Oryxen User Guide

Version: v0.20.27 | Last Updated: 2026-04-28

Welcome to Oryxen 🔒 — a private, secure way to chat with AI models. This guide walks you through everything from creating your API key to attaching documents for smart, context-aware answers.

Table of Contents

  1. What is Oryxen?
  2. Getting Started
  3. Logging In
  4. The Sidebar
  5. Using the Chat
  6. Recovering a Lost Key
  7. Security Tips
  8. Troubleshooting

🔐 What is Oryxen?

Oryxen is an AI chat platform that keeps your conversations private.

Unlike other services, your messages are encrypted end-to-end — nobody, not even the server operator, can read what you type. You get your own API key, and you control your data.

Feature Description
Private Chat Talk to AI models (Llama, DeepSeek, Kimi, Gemma, and more)
Inline Documents Attach files directly from chat input for smart answers
Vision Models Send images to AI that can see and describe them
Key Recovery 12-word backup phrase to restore lost keys
Secure by Design API key never stored in the system

🚀 Getting Started

Step 1 — Generate an API Key

To use Oryxen, you need an API key. Think of it like a password, but longer and more secure.

# Action
1 Go to the Oryxen login page and click “Generate a new API key”
2 Read the security information carefully
3 Check the box that says you understand, then click Continue

Step 2 — Save Your Backup Phrase

After generating your key, you will see a 12-word backup phrase. This is extremely important.

Warnings - If you lose your API key, this phrase is the only way to get it back - Anyone with this phrase can access your account - There is no “forgot password” button — we cannot help you if you lose both

Save it safely - Write it down on paper and store it somewhere secure (a safe, a locked drawer) - Save it in your password manager. - Do not email it to yourself - Do not take a screenshot (screenshots can be backed up to cloud services)

After saving it, check the box confirming you have saved it, then click Continue.

Step 3 — Save Your API Key

Next, you will see your actual API key. It looks something like this:

oryxen_aBcDeFgHiJkLmNoPqRsTuVwXyZ12345

Tip: Save this key somewhere safe, alongside your 12-word phrase. You will need it every time you log in.

Save it safely - Save it in your password manager. - Do not email it to yourself - Do not take a screenshot (screenshots can be backed up to cloud services)

After saving it, check the box confirming you have saved it, then click Continue.

Click Continue when you are done.

Step 4 — Wait for Activation

Your key starts in “pending” status. An administrator must activate it before you can use it.

Status Meaning
PENDING Waiting for admin approval
ACTIVE Ready to chat
INACTIVE Disabled by admin
  • Contact your Oryxen administrator with your key preview (the first few characters shown on screen)
  • Once activated, you can log in and start chatting

🔓 Logging In

# Action
1 Go to the Oryxen login page
2 Enter your API key in the text box
3 Click Connect
4 Your messages are automatically encrypted

Browser Requirements - Chrome 104+ | Firefox 132+ | Safari 17.4+ | Edge 104+

If your browser is too old, you will see a warning and cannot log in.

📊 The Sidebar

The sidebar on the left shows three key areas:

┌─────────────────────┐
│  E2EE               │  ← Encryption indicator
├─────────────────────┤
│  Model              │
│  ▼ chat-model       │  ← Model selector dropdown
├─────────────────────┤
│  This Chat          │
│  In  : 1,234        │  ← Input tokens
│  Out : 567          │  ← Output tokens
├─────────────────────┤
│  Tokens             │
│  Remaining  : 999M  │
│  Used Today : 1,801 │
│  Monthly    : 45K   │
├─────────────────────┤
│  oryxenweb v0.20.27 │  ← version (hover to brighten)
└─────────────────────┘

Model Selector

A dropdown at the top lets you choose which AI model to use.

Most of the models support text chat and documents analysis. Many have limited support for image analysis and optical character recognition(OCR).

Vision models specifically are optimized for image/video analysis.

Model Type How to Identify What You Can Do
Vision Name contains “vl” or “vision” Attach images
Chat Everything else Regular text chat and documents analysis

Tip: If you want to send images, switch to a vision model first!

Token Usage

Two stat cards show your usage:

Card What It Shows
This Chat Input and output tokens for the current conversation
Tokens Remaining / Used Today / Monthly Used

Running low? Contact your administrator to add more tokens.

Using the Chat

The Chat Input Area

At the bottom of the chat area you will find:

┌──────────────────────────────────────────────────────┐
│  [report.pdf] [data.csv]      ← document chips (RAG) │
│  [img.jpg]                     ← image thumbnails    │
├──────────────────────────────────────────────────────┤
│  [img] [doc] Type a message...              [Send]   │
└──────────────────────────────────────────────────────┘
Button What It Does
Attach Image Send images to vision-capable models
Attach Document Attach files for RAG-powered answers
Send Send your message

Header Buttons

At the top of the chat area, the header contains:

Button What It Does
+ New Chat Clears messages, documents, and images
Export Downloads the full chat as a Markdown file
Logout Ends your session and clears encryption keys

Sending a Message

# Action
1 Type your question in the text box (auto-expands up to 200px)
2 Press Enter or click the Send button
3 The AI responds in the chat window

Message Features - Assistant responses support Markdown, code blocks, tables, and math (LaTeX) - Click the copy button on any completed assistant message to copy the raw text - While the AI is thinking, you will see a spinner with “Oryxen is thinking” — no copy button appears during loading

⏰ Session Duration: Your session stays alive for up to 4 hours of inactivity. Any request to the server restarts the 4-hour clock, so you stay logged in while you keep working.

Attaching an Image (Vision Models)

You can send images to AI models that support vision:

# Action
1 Select a vision model from the dropdown (e.g., vision-model)
2 Click the image button next to the text box
3 Select an image file (JPG, PNG, GIF, WebP, etc.)
4 The image appears as a thumbnail above the text box
5 Type your question about the image and send

Why is the image button disabled?

If the image button is grayed out, hover over it — you will see:

Switch to a vision model to attach images

Select a model with vision capabilities from the dropdown.

Attaching Documents (RAG)

RAG = Retrieval-Augmented Generation

Attach documents and ask questions about their contents. The AI reads your files and bases its answers only on what you uploaded.

How to Attach a Document

# Action
1 Click the document button next to the text box
2 Select one or more documents

Supported formats:

Category Formats
Office PDF, Word (DOCX), PowerPoint (PPTX), Excel (XLSX)
Text TXT, Markdown (MD), CSV, JSON, XML, YAML
OpenDocument ODT, ODS, ODP
Web HTML, RTF
3 | Each document appears as a chip above the text box |

Document Chip States

State Appearance Meaning
Processing Teal dot File is uploading and being embedded
Ready Clean chip Available for RAG context
Failed Red text Upload error — try again or remove
4 | RAG is automatically enabled when at least one document is Ready |
5 | Type your question and send |

How it works: You only need to type your question. The AI sees your attached documents’ content as background context and answers based on them. If the answer is not in your documents, the AI will say so clearly.

Removing Documents

Action How
Remove one Click the x on a document chip
Delete from server Immediate — no undo
Select multiple files Hold Ctrl or Shift when clicking the document button

Privacy: Documents are private — only you can see them. They are isolated by your API key and deleted when you remove them.

Starting a Fresh Conversation

Click + New Chat in the header to clear everything:

New Chat clears: - All messages - All attached documents - All attached images

You get a completely clean slate.

⏰ Also remember that your session automatically expires after 4 hours of inactivity — the server keeps you logged in while you keep working.

🔑 Recovering a Lost Key

If you saved your 12-word backup phrase but lost your API key:

# Action
1 Go to the Oryxen login page
2 Click the “Recover Key” tab
3 Enter your 12-word phrase exactly as written (order matters!)
4 Click Recover Key
5 Your API key appears — copy and store it safely

Critical: If you lost both your API key and your 12-word phrase, your account cannot be recovered.

This is by design — nobody, including administrators, can access your key or phrase.

🛡️ Security Tips

Do This Never Do This
Keep your API key secret Share your API key
Write down your 12-word phrase on paper Email your phrase
Log out when done (especially on shared computers) Screenshot your phrase
Keep your browser updated Reuse your key on other sites

🔧 Troubleshooting

“Invalid API key”

Possible Cause Fix
Missing oryxen_ prefix Copy the entire key, including oryxen_
Key not activated Contact us — key may still be PENDING

“Encryption unavailable” warning

The browser must support WebCrypto API, we rely on this for safe cryptographic operations.

Fix Details
Update your browser Chrome 104+ / Firefox 132+ / Safari 17.4+
Try a different browser Chrome, Firefox, or Safari recommended

“No documents found” with RAG

Check Action
Still processing? Wait for the teal dot to disappear (Ready)
Failed upload? Remove the chip and try again
Vague question? Use words that actually appear in the document

“No embedding model available” tooltip

The document button is disabled because no provider with embedding models is configured.

Contact your administrator to add an embedding-capable provider, such as: - Internal provider with embedding-model - Any OpenAI-compatible provider with an embeddings endpoint

Image attach button is disabled

Cause Fix
Non-vision model selected Switch to a vision model (e.g., vision-model)
Hover shows tooltip “Switch to a vision model to attach images”

Page keeps redirecting to login

Step Action
1 Clear your browser cookies for the Oryxen website
2 Try logging in again with your API key
3 If it persists, contact us

🆘 Getting Help

Issue Type Who to Contact
Account issues (activation, lost keys) Contact us
Technical problems Check browser console (press F12) for error messages

OryxenWeb v0.20.27 | OryxenProxy v0.18.5 | Tinia v0.8.5