OpenAI Compatible

For SDKs, Cline, Cursor, and other tools that support the OpenAI-compatible protocol.

Prepare a key

YOUR_API_KEY is a placeholder in public documentation. Sign in to generate a configuration using one of your API keys.

Configure the endpoint

This tool uses the OpenAI-compatible protocol. Enter the URL below as the client's Base URL.

https://your-domain.example/v1

Copy configuration manually

If you do not use the CLI, replace YOUR_API_KEY with your API key. For real use, prefer the personalized configuration generator after signing in.

OpenAI SDK example

Cline, Cursor, SDKs, and other OpenAI-compatible tools can use this Base URL and API key.

app.ts

import OpenAI from 'openai'

const client = new OpenAI({
  apiKey: 'YOUR_API_KEY',
  baseURL: 'https://your-domain.example/v1',
})

const response = await client.chat.completions.create({
  model: 'YOUR_MODEL_ID',
  messages: [{ role: 'user', content: 'Hello' }],
})

console.log(response.choices[0].message.content)

Verify connectivity

Run this command. A successful model list means the endpoint and API key are working.

Terminal

curl "https://your-domain.example/v1/models" -H "Authorization: Bearer YOUR_API_KEY"