Installation

Detailed installation guide for all supported platforms.

Prerequisites

  • Node.js 18+ or Python 3.8+
  • npm, yarn, pnpm, or bun (for Node.js)
  • pip or poetry (for Python)

Node.js / TypeScript

Using npm

bash
npm install openai

Using yarn

bash
yarn add openai

Using pnpm

bash
pnpm add openai

Using bun

bash
bun add openai

Python

Using pip

bash
pip install openai

Using poetry

bash
poetry add openai

Using pipenv

bash
pipenv install openai

Verify Installation

Node.js

test.ts
import OpenAI from 'openai';

const client = new OpenAI({
  baseURL: 'https://superagentstack.orionixtech.com/api/v1',
  apiKey: 'test',
});

console.log('✅ OpenAI SDK installed successfully');

Python

test.py
from openai import OpenAI

client = OpenAI(
    base_url="https://superagentstack.orionixtech.com/api/v1",
    api_key="test"
)

print("✅ OpenAI SDK installed successfully")

Optional Dependencies

For Streaming (Next.js)

bash
npm install ai

For Environment Variables

bash
# Node.js
npm install dotenv

# Python
pip install python-dotenv

For Web Frameworks

bash
# Next.js
npx create-next-app@latest

# FastAPI (Python)
pip install fastapi uvicorn

# Flask (Python)
pip install flask

Troubleshooting

Module not found

Make sure you're in the correct directory and the package is installed:

bash
# Check if installed
npm list openai

# Reinstall if needed
npm install openai

TypeScript errors

Install type definitions:

bash
npm install --save-dev @types/node

Python import errors

Verify Python version and reinstall:

bash
python --version  # Should be 3.8+
pip install --upgrade openai

Need Help?

If you encounter any issues, check our error handling guide or contact support.

Next Steps