Skip to main content

🔌 Compatibility

This platform provides OpenAI-compatible API endpoints. Most clients and SDKs that support the OpenAI API can be used directly. Just swap the base URL and API key.

📡 Compatible Endpoints

Core Endpoints

PathDescription
/v1/chat/completionsChat completions (recommended)
/v1/responsesResponses-style chat
/v1/responses/compactResponses compact mode
/v1/messagesMessages format (Claude style)
/v1beta/modelsModel listing
/v1/embeddingsText embeddings
/v1/rerankReranking

Audio Endpoints

PathDescription
/v1/audio/speechText to speech
/v1/audio/transcriptionsSpeech to text
/v1/audio/translationsSpeech translation

💡 Tip

Actual endpoint availability depends on your account tier and the models you can call. Not all models support all endpoints.

🧪 Tested Clients

The following clients and tools have been verified to work with this platform:

AI Coding Tools

  • Cursor: configure OpenAI API Base URL and Key in settings
  • Continue: set apiBase and apiKey in config.json
  • Claude Code: see the dedicated setup guide
  • GitHub Copilot (compatibility mode)
  • Cline / Roo Code: VS Code extensions supporting OpenAI-compatible endpoints

ChatGPT-Compatible Clients

  • ChatGPT Next Web (ChatGPT-Next-Web)
  • LobeChat
  • Open WebUI
  • BotGem (AMA)
  • ChatBox

SDK

  • openai-python: official Python SDK
  • openai-node: official Node.js SDK
  • Any OpenAI-compatible SDK: Go, Java, C#, Ruby, etc.

✨ Compatible Features

  • Chat Completions: standard messages format, supports streaming
  • Responses API: Responses-style chat, for newer OpenAI SDKs and agent tools
  • Function Calling / Tools: tool use (depends on model support)
  • Streaming: SSE format, set stream=true
  • Multimodal input: image and file input (depends on model support)

🔧 Minimal Changes Required

For existing OpenAI API integrations, typically only two changes are needed:

# 1. Base URL
OPENAI_BASE_URL=https://your-domain/v1

# 2. API Key
OPENAI_API_KEY=sk-your-token-here

Request body format, parameter names, and response structure remain the same, so no client code rewrite is needed.

👉 Next Steps