Unreal OpenAI Documentation

Welcome to the Unreal OpenAI documentation. This documentation provides comprehensive information about the Unreal OpenAI API, which is compatible with the OpenAI SDK.

Getting Started

Unreal OpenAI provides a compatible interface with the OpenAI SDK, allowing you to easily integrate with your existing applications that use the OpenAI SDK.

Installation

You can use the OpenAI SDK to interact with OpenRouter:

# Using npm
npm install openai

# Using yarn
yarn add openai

# Using bun
bun add openai

Quick Start

import { OpenAI } from 'openai';

const openai = new OpenAI({
  apiKey: 'your-api-key',
  baseURL: 'https://openrouter.ai/api', // Replace with your OpenRouter endpoint
});

async function main() {
  const completion = await openai.chat.completions.create({
    model: 'unreal::llama4-scout-instruct-basic',
    messages: [
      { role: 'system', content: 'You are a helpful assistant.' },
      { role: 'user', content: 'Hello, how are you?' }
    ],
  });

  console.log(completion.choices[0].message);
}

main();

API Reference

Check out our API Reference for detailed information about all available endpoints and how to use them.

Features

• OpenAI SDK Compatibility: Use the OpenAI SDK to interact with OpenRouter
• Multiple Models: Access various AI models through a single API
• Simple Integration: Easy to integrate with existing applications