OpenCode2API

✨ 功能特性

🚀 快速开始

Docker 部署 (推荐)

# 1. 克隆并配置
git clone https://github.com/TiaraBasori/opencode2api.git
cd opencode2api
cp .env.example .env
# 2. 编辑 .env 设置你的配置
# 必填: API_KEY, OPENCODE_SERVER_PASSWORD
# 3. 启动
docker compose up -d
# 4. 测试
curl http://127.0.0.1:10000/health

Node.js (本地开发)

# 1. 安装 OpenCode CLI
npm install -g opencode-ai
# Linux/macOS: curl -fsSL https://opencode.ai/install | bash
# 2. 克隆并运行
git clone https://github.com/TiaraBasori/opencode2api.git
cd opencode2api
npm install
cp config.json.example config.json
npm start

🔧 外部工具调用

工作原理

客户端 (LangChain / OpenAI SDK / curl)
 │ 传入标准 OpenAI tools 格式
 ▼
OpenCode2API 代理层
 │ 1. 注册外部工具,加命名空间前缀 (external__)
 │ 2. 注入提示词引导模型输出 <function_calls> 格式
 │ 3. 模型输出后,解析并转换为标准 tool_calls
 │ 4. 若模型未正确输出工具调用,智能重试一次
 ▼
客户端收到标准 OpenAI tool_calls 响应

兼容性保障

Python 示例 (LangChain)

from langchain_openai import ChatOpenAI
from langchain.agents import create_agent
def get_weather(city: str) -> str:
 """获取指定城市的天气"""
 # ... 实际实现 ...
 return f"{city}当前天气:晴,气温26°C"
llm = ChatOpenAI(
 base_url="http://127.0.0.1:10000/v1",
 model="opencode/deepseek-v4-flash-free",
 api_key="your-api-key",
 temperature=0.2,
)
agent = create_agent(
 model=llm,
 tools=[get_weather],
 system_prompt="你是一个天气助手,请用中文回答。",
)
result = agent.invoke(
 {"messages": [{"role": "user", "content": "深圳今天天气怎么样?"}]}
)
print(result)

Python 示例 (OpenAI SDK)

from openai import OpenAI
client = OpenAI(
 base_url="http://127.0.0.1:10000/v1",
 api_key="your-api-key",
)
response = client.chat.completions.create(
 model="opencode/deepseek-v4-flash-free",
 messages=[{"role": "user", "content": "深圳今天天气怎么样?"}],
 tools=[{
 "type": "function",
 "function": {
 "name": "get_weather",
 "description": "获取指定城市的天气",
 "parameters": {
 "type": "object",
 "properties": {
 "city": {"type": "string", "description": "城市名称"}
 },
 "required": ["city"]
 }
 }
 }]
)
if response.choices[0].message.tool_calls:
 for tc in response.choices[0].message.tool_calls:
 print(f"工具: {tc.function.name}, 参数: {tc.function.arguments}")

curl 示例

curl -X POST http://127.0.0.1:10000/v1/chat/completions \
 -H "Authorization: Bearer YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "model": "opencode/big-pickle",
 "messages": [{"role": "user", "content": "深圳今天天气怎么样?"}],
 "tools": [
 {
 "type": "function",
 "function": {
 "name": "get_weather",
 "description": "获取指定城市的天气",
 "parameters": {
 "type": "object",
 "properties": {
 "city": {"type": "string", "description": "城市名称"}
 },
 "required": ["city"]
 }
 }
 }
 ]
 }'

tool_choice 支持

💡 使用示例

Chat Completions

curl -X POST http://127.0.0.1:10000/v1/chat/completions \
 -H "Authorization: Bearer YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "model": "opencode/big-pickle",
 "messages": [{"role": "user", "content": "你好!"}],
 "stream": false
 }'

Responses API (带推理)

curl -N -X POST http://127.0.0.1:10000/v1/responses \
 -H "Authorization: Bearer YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "model": "gpt5-nano",
 "input": "用一句话打招呼",
 "reasoning": {"effort": "high"},
 "stream": true
 }'

Responses API + 外部工具流式

curl -N -X POST http://127.0.0.1:10000/v1/responses \
 -H "Authorization: Bearer YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "model": "opencode/big-pickle",
 "input": "查询东京天气",
 "stream": true,
 "tools": [
 {
 "type": "function",
 "function": {
 "name": "weather_lookup",
 "description": "Look up weather by city",
 "parameters": {
 "type": "object",
 "properties": {
 "city": {"type": "string"},
 "unit": {"type": "string"}
 },
 "required": ["city"]
 }
 }
 }
 ]
 }'

📦 部署方式

⚙️ 配置

快速参考

推荐生产配置

API_KEY=your-secret-key
OPENCODE_SERVER_PASSWORD=your-password
DISABLE_TOOLS=true
OPENCODE_EXTERNAL_TOOLS_MODE=proxy-bridge
OPENCODE_EXTERNAL_TOOLS_CONFLICT_POLICY=namespace
OPENCODE_INTERNAL_ALLOWED_TOOLS=web_fetch
OPENCODE_INTERNAL_TOOL_METRICS_ENABLED=true
OPENCODE_TOOL_DISCOVERY_FIXTURE=
OPENCODE_HEALTH_DETAILS_ENABLED=true
OPENCODE_HEALTH_DETAILS_REQUIRE_AUTH=true
OPENCODE_METRICS_ENABLED=false
OPENCODE_METRICS_REQUIRE_AUTH=true
OPENCODE_PROXY_PROMPT_MODE=plugin-inject
OPENCODE_PROXY_OMIT_SYSTEM_PROMPT=true
OPENCODE_PROXY_AUTO_CLEANUP_CONVERSATIONS=true

外部工具桥接说明

内置工具 allowlist 说明

结构化诊断与 Prometheus 指标

🔌 API 参考

端点

模型名称格式

🔧 故障排查

请求卡住但 /v1/models 正常

USE_ISOLATED_HOME=false # 让 OpenCode 复用本地登录态

模型找不到

工具调用不生效

没有推理输出

🔨 开发

# 运行测试
npm test -- --runInBand
# Docker 开发
docker compose up -d --build

📄 许可证

🙏 致谢