OrcAI Documentation

Unified AI platform with integrated CLI tools, bot framework, and API gateway.

🟣

Claude Code

Anthropic's agentic coding CLI. Edit files, run commands, and manage git workflows from your terminal.

Anthropic
🟢

Codex CLI

OpenAI's terminal-based coding agent. Read, change, and run code with sandboxed execution.

OpenAI
🔵

Gemini CLI

Google's open-source AI agent with 1M token context window. Free tier with generous limits.

Google
🟡

OpenClaw

Multi-channel AI bot framework. Connect to Telegram, Discord, Slack, WhatsApp and 10+ platforms.

Bot Framework

Why OrcAI?

OrcAI provides a unified gateway to access 50+ AI models from Anthropic, OpenAI, Google, and others through a single API key. Our platform integrates the best AI-powered CLI tools so developers can code faster, smarter, and more efficiently.

  • One API, all models — Claude, GPT, Gemini, and more through one endpoint
  • Integrated CLI tools — Claude Code, Codex, and Gemini CLI with one-click install
  • 99.9% uptime SLA — Global edge network with automatic failover
  • Cost optimization — Smart routing reduces API costs by up to 40%
  • OpenClaw bot framework — Deploy AI assistants across 13+ messaging platforms

Architecture

System Architecture
┌─────────────┐    ┌─────────────┐    ┌─────────────┐
│ Claude Code │    │  Codex CLI  │    │ Gemini CLI  │
│   (Local)   │    │   (Local)   │    │   (Local)   │
└──────┬──────┘    └──────┬──────┘    └──────┬──────┘
       │                  │                  │
       └──────────────────┼──────────────────┘
                          │
                 ┌────────▼────────┐
                 │   OrcAI Gateway  │
                 │  api.orcai.cc    │
                 └────────┬────────┘
                          │
          ┌───────────────┼───────────────┐
          │               │               │
   ┌──────▼──────┐ ┌──────▼──────┐ ┌──────▼──────┐
   │  Anthropic  │ │   OpenAI    │ │   Google    │
   │  Claude API │ │   GPT API   │ │ Gemini API  │
   └─────────────┘ └─────────────┘ └─────────────┘

Quick Start

Get up and running with OrcAI in under 5 minutes.

Step 1: Create an Account

Sign up at api.orcai.cc/portal with your email. You'll receive a verification code to complete registration.

Step 2: Get Your API Key

Navigate to Dashboard → API Keys and create a new key. Copy it — you'll need it for all CLI tools.

Keep your API key secure Never commit API keys to version control. Use environment variables or .env files instead.

Step 3: Configure Your Environment

bash
# Set your OrcAI API key
export ORCAI_API_KEY="your-api-key-here"

# OrcAI gateway is compatible with OpenAI SDK
export OPENAI_API_KEY="$ORCAI_API_KEY"
export OPENAI_BASE_URL="https://api.orcai.cc/v1"

# For Anthropic SDK compatibility
export ANTHROPIC_API_KEY="$ORCAI_API_KEY"
export ANTHROPIC_BASE_URL="https://api.orcai.cc"

Step 4: Install a CLI Tool

Choose one or install all three:

One-Click Install (All CLI Tools)

$ curl -fsSL https://api.orcai.cc/install.sh | bash

Or install individually — see the One-Click Install page for details.

Step 5: Start Coding

Terminal
# Use Claude Code
$ claude "Create a REST API with Express"

# Use Codex CLI
$ codex "Build a React dashboard component"

# Use Gemini CLI
$ gemini "Analyze this codebase and suggest improvements"

One-Click Install

Install Claude Code, Codex CLI, and Gemini CLI with a single command.

Install All CLI Tools

$ curl -fsSL https://api.orcai.cc/install.sh | bash

This script detects your OS and installs all three CLI tools with the correct configuration for OrcAI gateway.

Individual Installation

Claude Code (Anthropic)

macOS / Linux
Windows
npm
bash
# macOS / Linux / WSL
curl -fsSL https://claude.ai/install.sh | bash

# Verify installation
claude --version
PowerShell
# Windows PowerShell
irm https://claude.ai/install.ps1 | iex

# Or via WinGet
winget install Anthropic.ClaudeCode
npm
npm install -g @anthropic-ai/claude-code

Codex CLI (OpenAI)

npm
Homebrew
Binary
bash
npm install -g @openai/codex
bash
brew install --cask codex
bash
# Download from GitHub Releases
# https://github.com/openai/codex/releases/latest

Gemini CLI (Google)

npx (no install)
npm
Homebrew
bash
# Run without installing
npx @google/gemini-cli
bash
npm install -g @google/gemini-cli
bash
brew install gemini-cli

System Requirements

ToolNode.jsOSNotes
Claude Code18+macOS, Linux, Windows (WSL)Native Windows via WinGet
Codex CLI22+macOS, Linux, WindowsBuilt in Rust, minimal deps
Gemini CLI18+macOS, Linux, WindowsOpen source, Apache 2.0

Claude Code

Anthropic's agentic coding tool that lives in your terminal.

Overview

Claude Code is an agentic coding tool by Anthropic that understands your entire codebase, executes routine tasks, explains complex code, and handles git workflows — all through natural language commands in your terminal.

Installation

Recommended (macOS / Linux / WSL)

$ curl -fsSL https://claude.ai/install.sh | bash

Configuration with OrcAI

bash
# Set OrcAI as your API provider
export ANTHROPIC_API_KEY="your-orcai-api-key"
export ANTHROPIC_BASE_URL="https://api.orcai.cc"

# Launch Claude Code
claude

Key Features

  • Multi-file editing — Search and modify files across your entire codebase
  • Git integration — Read issues, write code, run tests, submit PRs
  • Agentic search — No manual context selection, Claude finds what it needs
  • Plugin system — Custom commands and agents via slash commands
  • Agent SDK — Build programmatic agents with @anthropic-ai/claude-agent-sdk
  • MCP support — Connect to external tools via Model Context Protocol

Common Commands

Terminal
# Start interactive session
$ claude

# Run a single command
$ claude "explain this function"

# Fix a specific issue
$ claude "fix the login bug in auth.js"

# Create a commit
$ claude "/commit"

# Run diagnostics
$ claude doctor

# Update to latest version
$ claude update

Supported Models via OrcAI

ModelIDBest For
Claude Opus 4claude-opus-4-6Complex reasoning, large refactors
Claude Sonnet 4claude-sonnet-4-6Balanced speed + quality
Claude Haiku 3.5claude-haiku-4-5-20251001Fast tasks, simple edits

Codex CLI

OpenAI's terminal-based coding agent built in Rust.

GitHub Repository github.com/openai/codex — 61.6k+ stars

Overview

Codex CLI is OpenAI's local terminal-based coding agent that can read, change, and run code on your machine. Built primarily in Rust for maximum speed, it features sandboxed execution for security and integrates with VS Code, Cursor, and Windsurf editors.

Installation

via npm

$ npm install -g @openai/codex
npm
Homebrew
bash
npm install -g @openai/codex
bash
brew install --cask codex

Configuration with OrcAI

bash
# Use OrcAI as the OpenAI-compatible backend
export OPENAI_API_KEY="your-orcai-api-key"
export OPENAI_BASE_URL="https://api.orcai.cc/v1"

# Launch Codex
codex

Key Features

  • Built in Rust — 96% Rust codebase for maximum performance
  • Sandboxed execution — Landlock/seccomp on Linux for secure code execution
  • Editor integration — VS Code, Cursor, and Windsurf support
  • GitHub Actions — CI/CD integration with openai/codex-action@v1
  • Desktop app — Launch with codex app
  • Web search — Built-in web search tool for context gathering
  • Slash commands/review, /fork, custom prompts

Usage Examples

Terminal
# Interactive mode
$ codex

# Direct task
$ codex "Build a React dashboard component"

# Review code
$ codex "/review"

# Desktop app mode
$ codex app

Gemini CLI

Google's open-source AI agent with 1M token context window.

GitHub Repository github.com/google-gemini/gemini-cli — 95k+ stars, Apache 2.0

Overview

Gemini CLI is Google's open-source AI agent powered by Gemini models with a massive 1M token context window. It includes a free tier with generous limits (60 requests/min, 1,000 requests/day) and supports Google Search grounding, MCP servers, and conversation checkpointing.

Installation

Run without installing (npx)

$ npx @google/gemini-cli
npx
npm global
Homebrew
bash
# No install needed — runs via npx
npx @google/gemini-cli
bash
npm install -g @google/gemini-cli
bash
brew install gemini-cli

Configuration with OrcAI

bash
# Use OrcAI gateway for Gemini API
export GEMINI_API_KEY="your-orcai-api-key"

# Launch Gemini CLI
gemini

Key Features

  • 1M token context — Largest context window of any CLI tool
  • Free tier — 60 requests/min, 1,000 requests/day at no cost
  • Open source — Apache 2.0 license, fully transparent
  • Google Search grounding — Real-time web search integration
  • MCP support — Custom tool integrations via Model Context Protocol
  • Conversation checkpointing — Save and resume sessions
  • Custom context filesGEMINI.md for project-specific instructions
  • Non-interactive mode — Scriptable for automation pipelines

Free Tier Limits

LimitValue
Requests per minute60
Requests per day1,000
Context window1,000,000 tokens
CostFree (Google login)

OpenClaw

Multi-channel AI bot framework for Telegram, Discord, Slack, and 10+ platforms.

GitHub Repository github.com/openclaw/openclaw

Overview

OpenClaw is a personal AI assistant framework that runs on your own devices and connects to 13+ messaging platforms. It supports voice, browser control, device integration, and a powerful skill system for extending functionality.

Installation

Install via npm

$ npm install -g openclaw@latest
bash
# Install globally
npm install -g openclaw@latest

# Run onboarding
openclaw onboard --install-daemon

# Or install from source
git clone https://github.com/openclaw/openclaw.git
cd openclaw
pnpm install && pnpm ui:build && pnpm build
pnpm openclaw onboard --install-daemon

Telegram Bot Setup

  1. Create a bot via @BotFather on Telegram (/newbot)
  2. Configure the bot token in OpenClaw:
config.json5
{
  channels: {
    telegram: {
      enabled: true,
      botToken: "YOUR_BOT_TOKEN",
      dmPolicy: "pairing",
      groups: { "*": { requireMention: true } }
    }
  }
}
bash
# Start gateway and approve pairing
openclaw gateway
openclaw pairing list telegram
openclaw pairing approve telegram <CODE>

Supported Platforms

PlatformStatusFeatures
TelegramFull supportDM, groups, inline, voice
WhatsAppFull supportDM, groups, media
DiscordFull supportDM, channels, threads
SlackFull supportDM, channels, threads
SignalSupportedDM, groups
iMessagemacOS onlyDM
Google ChatSupportedDM, spaces
Microsoft TeamsSupportedDM, channels
MatrixSupportedDM, rooms
WebChatBuilt-inBrowser widget

Key Features

  • Multi-channel inbox — One AI, 13+ messaging platforms
  • Voice Wake + Talk — ElevenLabs voice integration
  • Browser control — Chrome/Chromium automation
  • Skill system — Extensible via ClawHub skills
  • Device nodes — Camera, screen recording, location (iOS/Android/macOS)
  • Local-first — Runs on your own devices, no cloud dependency
  • Pairing security — Secure authentication for DMs and groups

API Overview

OpenAI-compatible REST API for accessing 50+ AI models.

Base URL

Endpoint
https://api.orcai.cc/v1

Quick Example

cURL
Python
Node.js
bash
curl https://api.orcai.cc/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-6",
    "messages": [{"role": "user", "content": "Hello!"}],
    "max_tokens": 1024
  }'
Python
from openai import OpenAI

client = OpenAI(
    api_key="your-orcai-api-key",
    base_url="https://api.orcai.cc/v1"
)

response = client.chat.completions.create(
    model="claude-sonnet-4-6",
    messages=[{"role": "user", "content": "Hello!"}],
    max_tokens=1024
)
print(response.choices[0].message.content)
JavaScript
import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'your-orcai-api-key',
  baseURL: 'https://api.orcai.cc/v1'
});

const response = await client.chat.completions.create({
  model: 'claude-sonnet-4-6',
  messages: [{ role: 'user', content: 'Hello!' }],
  max_tokens: 1024
});
console.log(response.choices[0].message.content);

Endpoints

MethodEndpointDescription
POST/v1/chat/completionsChat completion (streaming supported)
GET/v1/modelsList available models
POST/v1/embeddingsGenerate text embeddings
POST/v1/images/generationsGenerate images (DALL-E, Midjourney)

Authentication

Secure your API requests with bearer token authentication.

API Key

All API requests require a valid API key passed in the Authorization header:

HTTP Header
Authorization: Bearer YOUR_API_KEY

Getting Your API Key

  1. Log in to OrcAI Portal
  2. Navigate to API Keys section
  3. Click Create New Key
  4. Copy the key — it won't be shown again
Security Best Practices
  • Never expose API keys in client-side code
  • Use environment variables: export ORCAI_API_KEY="sk-..."
  • Rotate keys regularly from the dashboard
  • Use separate keys for development and production

Rate Limits

PlanRequests/minRequests/dayModels
Starter (Free)101,0003
Pro ($49/mo)100100,00050+
EnterpriseCustomUnlimited50+ & Custom

Models

50+ AI models from leading providers, accessible through one API.

Anthropic Models

ModelIDContextBest For
Claude Opus 4claude-opus-4-6200KComplex reasoning, coding
Claude Sonnet 4claude-sonnet-4-6200KBalanced performance
Claude Haiku 3.5claude-haiku-4-5-20251001200KFast, lightweight tasks

OpenAI Models

ModelIDContextBest For
GPT-4ogpt-4o128KMultimodal, general purpose
GPT-4o Minigpt-4o-mini128KCost-effective tasks
o1o1200KAdvanced reasoning
o3o3200KDeep reasoning

Google Models

ModelIDContextBest For
Gemini 2.5 Progemini-2.5-pro1MLarge context tasks
Gemini 2.5 Flashgemini-2.5-flash1MFast, cost-effective
Smart Model Routing OrcAI can automatically route requests to the optimal model based on task complexity. Set "model": "auto" to enable smart routing.