diff --git a/README.md b/README.md index dfd0d26..5b9ad33 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,32 @@ # 元境平台 -a llm application, which can select differences llm avaiable in the backend, can interacts with the llm, if click the text widget in message showing area, the will call tts server to translate text inside the widget to audio and speak it out +## 申请APIKEY + +用户需要在元境平台(https://opencomputing.ai)上注册和登录, 登录后点击左上角元境平台进入菜单,点击“下位系统接口-下位系统, 在界面中点击“创建APIKEY” + +输入信息后点击提交,APIKEY创建完成 + +点击"复制apikey", 在弹出窗口看到apikey, 复制他 + +## 充值 +用户需要在元境平台上充值,目前支持alipay(支付宝)充值 + +操作方法 + +* 用户登录 +* 呼出用户菜单(点击右上角用户名) +* 点击充值 +* 输入充值信息 +在弹出界面中选择支付宝充值,输入合适的金额,点击提交转支付宝充值页面, 完成后等1分钟,查看账户当前余额 + +## 查看当前余额 + +* 用户登录 +* 呼出用户菜单 +* 点击财务 + +## base url +https://opencomputing.ai ## openai 兼容接口 我们提供一套兼容openai的API @@ -11,7 +37,7 @@ a llm application, which can select differences llm avaiable in the backend, can ``` { "Content-Type": "application/json", - "Authorization": "Bearer XXXX" # XXXX是客户从元境平台申请到的APIKEY + "Authorization": "Bearer " # 客户从元境平台申请到的APIKEY } ``` * data @@ -661,7 +687,7 @@ data: [DONE] ``` { "Content-Type": "application/json", - "Authorization": "Bearer XXXX" # XXXX是客户从元境平台申请到的APIKEY + "Authorization": "Bearer " # 客户从元境平台申请到的APIKEY } ``` * data @@ -709,7 +735,7 @@ data: [DONE] ``` { "Content-Type": "application/json", - "Authorization": "Bearer XXXX" # XXXX是客户从元境平台申请到的APIKEY + "Authorization": "Bearer " # 客户从元境平台申请到的APIKEY } ``` * params @@ -752,3 +778,9 @@ data: [DONE] } ``` +## 错误信息 + +* 401: {"error": "Invalid API Key"} +* 400: {"error": "Missing required parameter: prompt"} +* 429: {"error": "Insufficient balance"} (余额不足) +