Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clearmaas.com/llms.txt

Use this file to discover all available pages before exploring further.

ClearMaas is an OpenAI-compatible API gateway that works with any AI agent tool supporting custom base URL or API key configuration. Through a single endpoint, access 570+ models — Claude, GPT, Grok, DeepSeek, Qwen, GLM, Kimi, Doubao, and more — at provider cost price.

Supported agents

AgentProtocolQuick setup
Claude CodeAnthropic2 env vars
Codex CLIOpenAI2 env vars
OpenCodeOpenAIJSON config
Hermes AgentOpenAIYAML config
Zed EditorOpenAISettings UI
TRAE IDEOpenAI / AnthropicSettings UI
WorkBuddyOpenAISettings UI
OpenClawOpenAIJSON config

Connection patterns

Most agents follow one of two patterns:
PatternBase URLAPI Key env var
OpenAI-compatiblehttps://api.clearmaas.com/v1OPENAI_API_KEY
Anthropic-compatiblehttps://api.clearmaas.comANTHROPIC_API_KEY
Set the corresponding environment variable and all model requests route through ClearMaas automatically.

Model naming

ClearMaas uses provider/model-name prefixes. You can switch providers without changing tools:
PrefixExample model ID
openai/openai/gpt-4o-mini
anthropic/anthropic/claude-sonnet-4.6
google/google/gemini-2.5-pro
deepseek/deepseek/deepseek-chat
grok/grok/grok-4-fast-reasoning
qwen/qwen/qwen3.6-plus
kimi/kimi/kimi-k2.6
minimax/minimax/minimax-m2.7
See Model reference for the full list.

Next steps

Claude Code

Anthropic’s official agentic CLI — 2 environment variables to connect.

Codex CLI

OpenAI’s official coding agent via custom provider in config.

OpenCode

Terminal TUI assistant with JSON config for any provider.

Model reference

Browse all 570+ available models and their IDs.