章节目录
Service API 接入 · 01
接入前准备（由部署方提供）
以下信息不由本文档固定，需向你的 OpenJellyfish 部署方 / 服务管理员索取：
| 项 | 说明 | 示例占位符 |
|---|---|---|
| Base URL | 实例对外 HTTPS 地址 + /api/v1 前缀 | https://<你的部署域名>/api/v1 |
| Service API Key | 格式 sk-svc-...，在管理端 设置 → Service 管理 → API Keys 创建 | sk-svc-<由部署方提供> |
| Service ID（可选） | 独立聊天页为 /s/<service_id>；多 Service 时用于区分 | svc_xxxxxxxx |
Key 一服务一密，请妥善保管。轮换或新增 Key 请联系部署方管理员。切勿把 Key 提交到公开仓库或写进前端代码。
下文示例统一使用环境变量，复制前替换为你的实际值：
bash
export JF_BASE_URL="https://<你的部署域名>/api/v1"
export JF_API_KEY="sk-svc-<由部署方提供>"v1.3.1：接入 Codex / Cursor 套餐 Service
部署方可以将已授权的 Codex / Cursor 连接绑定到 Service。调用方继续使用上面的 Service Key 和现有接口，不需要供应商账号、CLI 或额外 LLM API Key。先查询 GET /api/v1/models 确认 Key 模式；套餐 Service 只接受 hosted，连接与模型由管理员固定。
model 参数保留 SDK 兼容性，不会改变套餐 Service 的模型。不要提交 provider、api_key、base_url 或 region；这些凭据字段会被拒绝。文档后面的多媒体示例受服务引擎与已开放能力限制：套餐 Service 暂不支持语音、视频、定时任务。流断开会取消本轮 Service 任务；续聊需保存 conversation_id，不可依赖不同 Key / 渠道共享原生会话。
Service Key 是服务级共享访问凭据，不是个人成员登录；请仅向获准使用该 Service 的成员分发。套餐模式当前用于可信内部成员。