proxycast/docs/content/02.user-guide/8.api-server.md

title, description, navigation

title	description	navigation
本地 API 接入	将 Lime 能力暴露给外部工具（进阶）	icon i-heroicons-server

本地 API 接入

::alert{type="info"} 这是进阶能力。普通创作者可以不配置，直接在应用内完成创作。 ::

当你希望把 Lime 接入脚本、自动化工具或第三方客户端时，可启用本地 API。

核心说明

• 服务默认在本地地址运行
• 通过 API Key 控制访问
• 支持常见兼容接口形态

快速配置

1. 进入设置中的 API Server
2. 开启服务并确认端口
3. 设置或生成 API Key
4. 使用一条测试请求验证连通性

最小测试示例

curl http://127.0.0.1:8999/v1/chat/completions \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"model":"your-model","messages":[{"role":"user","content":"你好"}]}'

安全建议

1. 只在本机环境使用
2. 不要把 API Key 提交到代码仓库
3. 定期更换密钥并清理无效连接

常见问题

启动后无法访问

先确认端口未被占用，再检查本地防火墙策略。

请求总是 401

通常是 API Key 填写错误或请求头格式不正确。