Getting Started
Set up your environment and make your first API call in minutes.
Documentation
Everything you need to build on Riven.
API reference, integration guides, SDK documentation, and developer resources for the full Riven platform.
API Reference
Complete endpoint reference for chat completions, models, embeddings, and more.
SDKs & Libraries
Official SDKs for JavaScript, Python, and other languages.
Integrations
Connect Riven to your existing tools and workflows.
Guides
Step-by-step tutorials.
Follow along with practical guides covering common integration patterns and use cases.
Build a Chat Application
Create a conversational AI interface using the Riven API with streaming responses.
Read guideAuthentication & API Keys
Manage API keys, set rate limits, and configure access controls for your team.
Read guideEnterprise Deployment
Deploy Riven in your organization with SSO, audit logging, and compliance controls.
Read guideQuickstart
Make your first API call.
The Riven API is fully compatible with the OpenAI SDK. Point your existing code at our endpoint and you are running on the Riven platform.
- 1Get your API key from the Riven console
- 2Set your base URL to
https://api.rivenai.io/v1 - 3Make a chat completion request using the OpenAI SDK
install.sh
npm install openai
# or
pnpm add openaiexample.ts
import OpenAI from 'openai'
const client = new OpenAI({
apiKey: process.env.RIVEN_API_KEY,
baseURL: 'https://api.rivenai.io/v1',
})
const response = await client.chat.completions.create({
model: 'riven-reasoning-v1',
messages: [
{ role: 'system', content: 'You are a helpful assistant.' },
{ role: 'user', content: 'What is the Riven platform?' },
],
stream: true,
})
for await (const chunk of response) {
process.stdout.write(chunk.choices[0]?.delta?.content || '')
}Ready to build?
Get your API key and start building on the Riven platform today.