Skip to main content

Compatibility

To connect an app or SDK built for the OpenAI API, change two things: the base URL and the API key.

Supported endpoints

Main endpoints

PathDescription
/v1/chat/completionsChat completions (recommended)
/v1/responsesResponses API conversations
/v1/responses/compactResponses compact mode
/v1/messagesMessages format (Claude)
/v1beta/modelsList models
/v1/embeddingsText embeddings
/v1/rerankReranking

Audio endpoints

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

Check the model first

The Models page shows which endpoints each model supports, and your account tier decides which models you can call.

Apps and tools

You can connect these apps and tools:

Roleplay apps

  • SillyTavern: Chat Completion with the Custom (OpenAI-compatible) source
  • JanitorAI: the proxy option, with the full /v1/chat/completions URL

AI coding tools

  • Cursor: set the OpenAI API base URL and key in its settings
  • Continue: set apiBase and apiKey in config.json
  • Claude Code: follow the setup guide
  • GitHub Copilot (compatibility mode)
  • Cline / Roo Code: VS Code extensions; pick the OpenAI Compatible provider

Chat apps

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

SDKs

  • openai-python: the official Python SDK
  • openai-node: the official Node.js SDK
  • Other SDKs that speak the OpenAI API: Go, Java, C#, Ruby and more

Features

  • Chat Completions: the standard messages format, with streaming
  • Responses API: used by newer OpenAI SDKs and agent tools
  • Function Calling / Tools: on models that support tools
  • Streaming: SSE; set stream=true
  • Multimodal input: images and files, on models that support them

Switch existing code

If your code already calls the OpenAI API, change two things:

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

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

Everything else stays the same: request bodies, parameter names and responses.

Next steps