Documentation
Quickstart
From signup to your first successful API call in under five minutes.
Sign up#
- 1. Sign up — Create a free account at orux.top/register. You get 200 Credits on signup, no card required.
- 2. Create an API key — Open the dashboard → API Keys → New key. Keys are AES-GCM encrypted at rest; reveal the full secret any time from the key list (eye icon).
- 3. Choose a model — Browse model ids at /docs/models. For chat, try claude-opus-4.7 (Claude), gpt-5.5 (GPT) or gemini-3-pro (Gemini)
- 4. Make your first call — Drop in any OpenAI-compatible SDK. Only two things change vs. OpenAI: the api_key and the base_url.
Reveal your key anytime
You can re-read the plain-text secret from the keys list while you are logged in. No need to re-create keys if you lose the value.
Your first request (non-streaming)#
The simplest possible call. The response is a single JSON document with the assistant message and a usage breakdown.
curl https://orux.top/api/v1/chat/completions \
-H "Authorization: Bearer $ORUX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-opus-4.7",
"messages": [{"role": "user", "content": "Hello, Orux AI."}]
}'Same call, streaming#
Set stream: true to receive deltas via Server-Sent Events. The OpenAI SDK exposes them as an async iterator.
curl https://orux.top/api/v1/chat/completions \
-H "Authorization: Bearer $ORUX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-opus-4.7",
"messages": [{"role": "user", "content": "Stream me a sentence."}],
"stream": true
}'Verifying the response#
A successful response contains an id (chatcmpl-...), an object field of "chat.completion", a choices array with one message per request, and a usage block with prompt_tokens, completion_tokens and total_tokens.