Skip to main content
Orux AIOruxAI
Developer docsAPI reference

Get started

Quickstart

Get your API key and make your first request in a few minutes.

1. Create an API key

Sign up and open the API Keys page in your dashboard, then create a new key. The key is shown in full only once — copy it somewhere safe. If it is lost, create a replacement and revoke the old key.

Keys are prefixed with sk- and should be treated like a password: never commit them to source control or expose them in client-side code.

2. Make your first request

Orux AI speaks the OpenAI API protocol. Point any OpenAI-compatible client at https://orux.top/api/v1 and pass your key as a bearer token — no other code changes are required.

3. Where to go next

  • Authentication — how bearer tokens are validated and best practices for storing keys.
  • Chat — streaming and non-streaming chat completions.
  • Embeddings — vector embeddings for search and retrieval.
  • Images — synchronous image generation.
  • Async tasks — video and audio/music generation, which run as background jobs.
  • Models — how to list the models currently available to your key.