Quick Start

One API key gives you access to 100+ LLMs, including GPT, Claude, Gemini, and DeepSeek. First, choose how you want to use OfoxAI.

Choose How to Use OfoxAI

Use in tools (no code) Enter the API address and key in tools such as Cherry Studio, Claude Code, Codex, or Chatbox.Integrate via API (code) Compatible with the official OpenAI, Anthropic, and Gemini SDKs. Only the API address and key need to change.

Integrate the API in Three Steps

Get an API Key

Sign in to the OfoxAI Console , go to Settings → API Keys, and create a new key. The key is shown only once when it is created, so store it securely. See API Key Setup & Usage for details.

Set the API Address

Choose the address that matches the SDK you use:

OpenAI compatiblehttps://api.ofox.ai/v1General purpose, recommended

Anthropic nativehttps://api.ofox.ai/anthropic

Gemini nativehttps://api.ofox.ai/gemini

Send Your First Request

Replace <your OFOXAI_API_KEY> with the key from step 1 and run the code. If you receive a reply from the model, the integration is working.

cURL

Terminal


curl https://api.ofox.ai/v1/chat/completions \
  -H "Authorization: Bearer <your OFOXAI_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-6.1-sol",
    "messages": [
      {"role": "user", "content": "What is the meaning of life?"}
    ]
  }'

Python

quickstart.py


from openai import OpenAI
 
client = OpenAI(
    base_url="https://api.ofox.ai/v1",
    api_key="<your OFOXAI_API_KEY>"
)
 
response = client.chat.completions.create(
    model="openai/gpt-6.1-sol",
    messages=[{"role": "user", "content": "What is the meaning of life?"}]
)
 
print(response.choices[0].message.content)

TypeScript

quickstart.ts


import OpenAI from 'openai'
 
const client = new OpenAI({
  baseURL: 'https://api.ofox.ai/v1',
  apiKey: '<your OFOXAI_API_KEY>'
})
 
const response = await client.chat.completions.create({
  model: 'openai/gpt-6.1-sol',
  messages: [{ role: 'user', content: 'What is the meaning of life?' }]
})
 
console.log(response.choices[0].message.content)

To use the official Anthropic or Gemini SDK, see Anthropic Messages and Gemini Generate Content.

Find by Task

Use with Claude Code Connect the coding assistant to OfoxAI, including environment variable setup.Chat in Cherry Studio Add OfoxAI as a provider in the chat client.Generate and edit images GPT Image text to image, image editing, and inpainting.Generate video Asynchronous tasks: create, retrieve, and callbacks.Migrate an existing OpenAI project Only base_url and the API key need to change.Reduce costs Prompt caching and provider routing.Handle errors Common error codes, retries, and troubleshooting.Browse all models Model IDs, pricing, and context length.

More Resources

API Key Setup & Usage: how to include the key in requests for each of the three protocols
Pricing and Usage Tracking
Security & Data
API Reference: parameters and responses for every endpoint