无需修改官方 SDK,即可将 LinkHarbor 用于 OpenAI SDK、Cursor、Cline、OpenWebUI 及其他 OpenAI 兼容工具。
推荐使用环境变量配置 API Key 和 Endpoint。只需四步即可开始使用。
推荐通过环境变量配置 API Key 与 Endpoint,便于本地开发和工具接入。
根据运行环境安装官方 OpenAI SDK。安装前请确认系统已安装 Python 或 Node.js。
pip install openaiAPI Key 用于认证 OpenAI 兼容接口请求。请优先使用环境变量保存,避免将密钥硬编码到源码中。
export OPENAI_API_KEY="YOUR_API_KEY"设置 Base URL 后,SDK 会将请求发送到 LinkHarbor,而不是默认 OpenAI 端点。
export OPENAI_BASE_URL="https://api.linkharbor.ai/v1"完成配置后,即可开始发送 OpenAI 兼容请求。
平台支持标准 OpenAI 兼容 API 格式。所有请求都应包含 Authorization 请求头和 JSON content type。
https://api.linkharbor.ai/v1通过标准 OpenAI 兼容端点发送 Chat Completions 请求。
https://api.linkharbor.ai/v1/chat/completions通过标准 OpenAI 兼容端点发送 Chat Completions 请求。
所有 OpenAI 兼容请求都必须包含以下请求头。
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json所有请求都遵循标准 OpenAI Chat Completions 格式。
{
"model": "your-model-name",
"messages": [
{
"role": "user",
"content": "Hello"
}
]
}可直接使用官方 OpenAI SDK,无需修改 SDK。下面分别展示非流式和流式调用。
适合脚本、批处理和一次性获取完整响应的服务端任务。
curl https://api.linkharbor.ai/v1/chat/completions \
--header "Authorization: Bearer $OPENAI_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"model": "your-model-name",
"messages": [
{
"role": "user",
"content": "Hello"
}
]
}'适合聊天界面和需要边生成边展示的场景,响应会按 SSE/chunk 逐步返回。
curl -N https://api.linkharbor.ai/v1/chat/completions \
--header "Authorization: Bearer $OPENAI_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"model": "your-model-name",
"messages": [
{
"role": "user",
"content": "Hello"
}
],
"stream": true
}'三个习惯可以让你的接入更安全、更稳定。
避免将 API Key 写入源码、示例、终端历史记录或公开仓库。
Cursor、Cline、OpenWebUI、OpenAI SDK 以及类似 OpenAI 兼容客户端都可以使用该端点。
长期有效的密钥可以减少因频繁更换密钥导致的工具连接失败。
开发者最常见问题的快速解答。
了解 OpenAI 兼容聊天请求的请求字段和响应字段。
阅读文档查看可传入 Chat Completions 的模型 ID。
查看模型将 Agent 工具配置到 LinkHarbor 兼容端点。
配置工具