【 API 】接入指南 🚀

API Compatibility
Loap API 同时支持 ⭐ OpenAI API 格式和 ⭐ Chat Nio API 调用方式。
您可以通过 OpenAI API 格式兼容市面上的各种工具和模型，也可以通过 Loap API 调用方式使用 Chat Nio 的独有功能。
下文讲述如何使用 OpenAI API 格式接入 Chat Nio。

💻 API 接入点

提示
下文以 Loap API 官方站 为例，其他站点请更换接入点为对应站点的接入点。

站点示例：如 https://api.loap.cc 的接入点为 https://api.loap.cc/v1 或者 https://api.loap.cc/api/v1

OpenAI API 中转接入点为: https://api.loap.cc/v1
实际请求 URL 为: https://api.loap.cc/v1/chat/completions, 但各个工具/客户端的补全可能不同, 比如:
- Next Chat 应为 https://api.loap.cc (不需要补全 /v1)
- Lobe Chat 应为 https://api.loap.cc/v1 (需要补全 /v1)
- GPT-Academic 应为 https://api.loap.cc/v1/chat/completions (应用侧不补全)

🚀 获取 API Key

登录 Loap API 官网，点击右上角的头像，进入下拉菜单。点击 API 设置，复制您的 API Key 即可 (如果 Key 为空，请点击刷新按钮)。
或者从侧边栏进入，同上述步骤获取 API Key。

🧚‍♀️ 常用工具对接

联网搜索

Loap API 提供了联网搜索功能，可以通过设置在模型前面加上 web- 前缀来启用联网搜索功能，如 web-gpt-3.5-turbo。
(仅需要在其他项目中设置 web- 模型名，不需要在 Chat Nio 对接时设置)

Next Chat
- 设置中启用 自定义接口
- 服务商选择 OpenAI
- 接口地址填写 https://api.loap.cc
- API Key 填写上文获取的 API Key
Lobe Chat
- 设置设置接入点为 https://api.loap.cc/v1
One API / New API
- 进入渠道选项添加 OpenAI 类型渠道
- 接口地址填写 https://api.loap.cc
- 密钥填写上文获取的 API Key
- 勾选需要导入的模型列表 (自定义模型需要手动输入模型名)
Chat Nio
- 进入后台管理的渠道页点击 对接上游
- 接入点填写 https://api.loap.cc
- 密钥填写上文获取的 API Key
- 点击对接按钮即可快速同步上游渠道并同步支持模型
Chat Box
- 代理设置为 https://api.loap.cc
- API Key 填写上文获取的 API Key
GPT Academic
- 配置中自定义 Key 格式设置为：CUSTOM_API_KEY_PATTERN = "sk-[a-zA-Z0-9]{64}$"
- 配置中增加 URL 重定向：API_URL_REDIRECT = {"https://api.openai.com/v1/chat/completions": "https://api.loap.cc/v1/chat/completions"}
- 配置填写上文获取的 API Key
ChatGPT Sidebar
- 设置中填写接入点为 https://api.loap.cc
- API Key 填写上文获取的 API Key

OpenAI SDKs (Python)

python

import openai

openai.base_url = "https://api.loap.cc/v1" # 接入点
openai.api_key = "sk-..." # 填写上文获取的 API Key
openai.skip_checking = True # 跳过模型检查

response = openai.ChatCompletion.create(
    model="gpt-3.5-turbo",
    messages=[
        {"role": "system", "content": "hi"},
    ]
)

print(response.choices[0].message.content)

💻 API 接入点​

🚀 获取 API Key​

🧚‍♀️ 常用工具对接​

💻 API 接入点

🚀 获取 API Key

🧚‍♀️ 常用工具对接