# API企业中转服务
{% hint style="info" %}
**tip:**
**支持模型：**gpt-3.5-所有模型、gpt4所有模型、OpenAI语音模型、微软必应、谷歌模型、Caude模型
**可用地区：**全球可用，全球CDN分发，高弹性可用
**接口类型：**完全兼容 OpenAI 接口协议，支持无缝对接各种支持 OpenAI 接口的应用。
**使用按量：**无时间限制，日志记录，明细可查，每一笔消耗都公开透明。
**交互友好：**操作简单，两步调用 API：替换修改 api host 和 key 值即可。
**网站客服：**平台有专业客服，10:00\~22:00 提供售前咨询和售后保障服务。
{% endhint %}
## 开始 【2024.4.19更新】
API 面板地址:
## 📣API 服务价格更新【2024.5.28】📣
亲爱的用户们，为了让大家一目了然地了解我们的优惠价格，现将详情公布如下：
✅ 本站充值比例：2.5RMB=$1
✅ 本站模型费率：与官方保持 1:1
✅ 【官方价格表】: [点此查看](https://openai.com/api/pricing/)
因此，本站的最终费率 = 汇率差 = 2.5 / 7.25 = 34.48%
**🚀 结果说明：在本站使用 API 相当于官方的 3.5 折 左右，即用 100RMB 可以节省 65 元。**
## 如何充值：
### 申请 API-KEY
1. **注册API面板用户登录之后首先充值**
为了用户体验我们设置的充值比例为 ¥2.5=$1
2. **创建自己的令牌**
3. **点击复制按钮获取自己的令牌**
## 如何使用？
{% embed url="" %}
### 在API 令牌面板中一键使用
点击聊天按钮进入 chat 页面
点击确认自动完成设置，之后聊天即可
点击这里可以切换模型
### 使用令牌和接口地址在第三方插件中使用
[推荐的插件在这里](#di-san-fang-cha-jian-ru-he-jie-ru)
我们以ChatGPTNext举例，首先点击聊天打开
1. **点击，进入设置页面**
2. **填入：**[**https://api.gpt2share.com**](https://api.gpt2share.com)
3. **填入自己的**[**API-KEY**](#shen-qing-apikey)
4. **选择想要调用的模型之后点击右上角 X 进入聊天页面即可**
## 开发者如何接入
您可以使用OpenAi-ChatGPT的Python库来使用
您可以修改：api\_base 和 api\_key两个参数来对接本平台
api\_base ：请输入：
api\_key : 请输入：网站首页生成的API 密钥
## ChatGPT API 文档
GPT2Share 完全仿照 OpenAI 官网设定，你可以直接在 OpenAI API 文档查阅如何使用： （需翻墙）
## ChatGPT API 例子
你需要自行在 Header 部分完成鉴权：Authorization: Bearer sk-xxxx
### 绘画
地址：
```json
{
"model": "gpt-4-s",
"prompt": "",
}
```
### 对话
地址：
```json
{
"model": "gpt-3.5-turbo",
"messages": [
{
"role": "system",
"content": "You are a helpful assistant."
},
{
"role": "user",
"content": "Hello!"
}
]
}
```
同时，你也可以进行流请求（返回多次响应，每次返回一个字或几个字）
```json
{
"model": "gpt-3.5-turbo",
"messages": [
{
"role": "system",
"content": "You are a helpful assistant."
},
{
"role": "user",
"content": "Hello!"
}
],
"stream": true
}
```
你的模型需要根据官网文档来进行配置
## MidJourney API 使用
如果你只是需要使用 MidJourney 功能的话，请直接看本节内容：
1. 打开 [GPT2Share-MidJourney](https://picture.soruxgpt.com/)
2. 填写 API
其中，MidJourney Api Secret 为你的 GPT2Share 密钥
3. 使用即可
MidJourney 中文版教程：[访问地址](http://www.midjourney-zh.com/docs/%E5%85%A5%E9%97%A8%E6%95%99%E7%A8%8B/%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B/Midjourney)
### Prompt 使用实现注意
#### 对开发者
MidJourney 推荐 Prompt 是英文，因此你最好使用第三方的翻译软件、OpenAI 3.5-turbo API 将英文转换为中文后再输入给 MidJourney
#### 对个人用户
**如果你拥有 GPT2Share ChatGPT 节点：**
1. 打开 GPT-S，搜索 MidJourney
2. 例如，我们使用 MJ v6.0 作画
部分用户打开 GPTS 可能会出现无法显示，刷新即可输入我们的 Prompt例如我们复制一个 Prompt：A young girl standing under the sunlight, holding a red umbrella with an inverted hook handle, a bright blue sky filled with fluffy clouds above her. She smiles warmly towards the viewer, a loyal dog leaning against her feet. The scene radiates warmth and serenity. Created Using: vivid colors, soft lighting, gentle shadows, detailed textures, lifelike expressions, naturalistic animal depiction, harmonious composition, hd quality, natural look
3. 打开 GPT2Share 绘画程序
4. 查看效果
## MidJourney API接口说明
### 1. 数据结构
#### 任务
| 字段 | 类型 | 示例 | 描述 |
| ----------- | --------- | --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| id | string | 1689231405853400 | 任务ID |
| action | string | IMAGINE | 任务类型: IMAGINE（绘图）、UPSCALE（放大）、VARIATION（变化）、ZOOM（图片变焦）、PAN（焦点移动）、DESCRIBE（图生文）、BLEND（图片混合）、SHORTEN（prompt分析）、SWAP\_FACE（人脸替换） |
| status | string | SUCCESS | 任务状态: NOT\_START（未启动）、SUBMITTED（已提交处理）、MODAL（窗口等待）、IN\_PROGRESS（执行中）、FAILURE（失败）、SUCCESS（成功）、CANCEL（已取消） |
| prompt | string | 猫猫 | 提示词 |
| promptEn | string | Cat | 英文提示词 |
| description | string | /imagine 猫猫 | 任务描述 |
| submitTime | number | 1689231405854 | 提交时间 |
| startTime | number | 1689231442755 | 开始执行时间 |
| finishTime | number | 1689231544312 | 结束时间 |
| progress | string | 100% | 任务进度 |
| imageUrl | string | | 生成图片的url, 成功或执行中时有值，可能为png或webp |
| failReason | string | \[Invalid parameter] Invalid value | 失败原因, 失败时有值 |
| properties | object | {"finalPrompt": "Cat"} | 任务的扩展属性，系统内部使用 |
| buttons | Button\[] | \[] | 任务完成后的可执行按钮 |
#### **Button**
| 字段 | 类型 | 示例 | 描述 |
| -------- | ------ | ---------------------------------------------------------- | ----------------------- |
| customId | string | MJ::JOB::upsample::1::85a4b4c1-8835-46c5-a15c-aea34fad1862 | 动作标识 |
| emoji | string | 🪄 | 图标 |
| label | string | Make Variations | 文本 |
| type | number | 2 | 类型，系统内部使用 |
| style | number | 2 | 样式: 2（Primary）、3（Green） |
#### **properties 常见字段**
| 字段 | 类型 | 示例 | 描述 |
| ----------------- | ------ | -------------------------------------------- | ----------------------------------------------- |
| botType | string | NIJI\_JOURNEY | bot类型: MID\_JOURNEY,NIJI\_JOURNEY,INSIGHT\_FACE |
| discordInstanceId | string | 1118138338562560102 | 执行该任务的实例ID(频道ID) |
| finalPrompt | string | Cat | 消息内容提取出的prompt |
| messageId | string | 1174910863984033903 | 消息ID |
| messageContent | string | \*\*Cat\*\* - Image #1 <@590422081204912129> | 消息内容 |
### **任务提交返回**
* code=1: 提交成功，result为任务ID
```json
{"code": 1,"description": "提交成功","result": "14001929738841620","properties": {"discordInstanceId": "1118138338562560102"
}
}
```
* code=22: 提交成功，进入队列等待
```json
{"code": 22,"description": "排队中，前面还有1个任务","result": "14001929738841620","properties": {"numberOfQueues": 1,"discordInstanceId": "1118138338562560102"
}
}
```
* code=23: 队列已满，请稍后尝试
```json
{"code": 23,"description": "队列已满，请稍后尝试","result": "14001929738841620","properties": {"discordInstanceId": "1118138338562560102"
}
}
```
* code=24: prompt包含敏感词
```json
{"code": 24,"description": "可能包含敏感词","properties": {"promptEn": "nude body","bannedWord": "nude"
}
}
```
* other: 提交错误，description为错误描述
### **执行任务的关联动作**
调用 `/mj/submit/action`，几乎所有的button都做了支持，除了以下情况:
* 图生文结果的 `🎉Imagine all`
* 图片放大后的 `❤️`
```json
{
// 关联任务的ID
"taskId": "1689216801333574",
// 动作标识
"customId": "MJ::JOB::reroll::0::1c6dff5e-5632-40c6-9d4c-afb261705313::SOLO"
}
```
⚠️ 注意: 某些场景需要modal弹框确认
* 执行CustomZoom(自定义变焦)
* 执行️Region(局部重绘)
* 执行PicReader(Describe后选择生图)
* 执行PromptAnalyzer(Shorten后选择生图)
> 开启Remix模式时，执行Reroll、Variation、Pan也需要弹框确认；但账号设置了remix自动提交时，不需要确认
需要确认时返回的code为 21，示例:
```json
{
"code": 21,
"description": "窗口等待",
"result": "14001929738841620"
}
```
该任务状态为MODAL，但不会进队列影响并发。需调用`/mj/submit/modal`提交最终任务
```json
{
// 需确认的任务ID
"taskId": "1689228047868174",
// prompt: 为空时使用原任务的prompt
"prompt": "Cat"
}
```
* CustomZoom的prompt需要设置`--zoom`(1到2之间)，例如: `Cat --zoom 1.5`
* ️Vary (Region) 需要额外传`maskBase64`: 局部重绘的蒙版base64(底色纯黑，选中区域纯白)
### **`/mj/submit/describe`** **图生文**
```json
{
// 图片的base64字符串
"base64": "data:image/png;base64,xxx"
}
```
后续任务完成后，properties中finalPrompt即为图片生成的prompt，finalZhPrompt为翻译的中文
```json
{
"id":"14001929738841620",
"action":"DESCRIBE",
"status": "SUCCESS",
"description":"/describe 14001929738841620.png",
"imageUrl":"https://cdn.discordapp.com/attachments/xxx/xxx/14001929738841620.png",
"properties": {
"finalPrompt": "1️⃣ Cat --ar 5:4\n\n2️⃣ Cat2 --ar 5:4\n\n3️⃣ Cat3 --ar 5:4\n\n4️⃣ Cat4 --ar 5:4",
"finalZhPrompt": "1️⃣ 猫 --ar 5:4\n\n2️⃣ 猫2 --ar 5:4\n\n3️⃣ 猫3 --ar 5:4\n\n4️⃣ 猫4 --ar 5:4"
}
// ...
}
```
### **`/mj/submit/shorten`** **prompt分析**
```json
{
"prompt": "️appdash appdash, in the style of expert draftsmanship, commission for, ethereal, dreamlike quality, dadaistic, toonami"
}
```
后续任务完成后，properties中finalPrompt即为分析结果，finalZhPrompt为翻译的中文
```json
{
"id":"1689252749098647",
"action":"SHORTEN",
"status": "SUCCESS",
"description":"/shorten appdash appdash, in the style of expert draftsmanship, commission for, ethereal, dreamlike quality, dadaistic, toonami",
"properties": {
"finalPrompt": "## Important tokens\n**appdash** **appdash**, in the ~~style~~ of ~~expert~~ **draftsmanship**, commission for, ethereal, dreamlike quality, ~~dadaistic~~, **toonami**\n## Shortened prompts\n1️⃣ appdash appdash, draftsmanship, commission for, ethereal, toonami\n\n2️⃣ appdash appdash, draftsmanship, commission, toonami\n\n3️⃣ appdash appdash, draftsmanship, toonami\n\n4️⃣ appdash appdash, toonami\n\n5️⃣ appdash appdash",
"finalZhPrompt": "## 重要词汇\n**appdash** **appdash**，以专家的绘画风格，委托制作，飘渺的，梦幻般的质感，达达主义的，**toonami**\n## 简化提示\n1️⃣ appdash appdash，绘画风格，委托制作，飘渺的，toonami\n\n2️⃣ appdash appdash，绘画风格，委托制作，toonami\n\n3️⃣ appdash appdash，绘画风格，toonami\n\n4️⃣ appdash appdash，toonami\n\n5️⃣ appdash appdash"
}
// ...
}
```
对该任务执行 `Show Details` 动作，能获得进一步的分析结果
```json
{
"id":"1689253263953453",
"action":"SHORTEN",
"status": "SUCCESS",
"description":"/up 168925266642808397 Show Details",
"properties": {
"finalPrompt": "## Important tokens\n**appdash** (1.00) **appdash** (0.79), in the style (0.01) of expert (0.00) **draftsmanship** (0.09), commission (0.08) for, ethereal (0.05), dreamlike (0.02) quality (0.01), dadaistic (0.01), **toonami** (0.19)\n\n██████████ appdash\n████████░░ appdash\n██░░░░░░░░ toonami\n█░░░░░░░░░ draftsmanship\n█░░░░░░░░░ commission\n█░░░░░░░░░ ethereal\n## Shortened prompts\n1️⃣ appdash appdash, draftsmanship, commission for, ethereal, toonami\n\n2️⃣ appdash appdash, draftsmanship, commission, toonami\n\n3️⃣ appdash appdash, draftsmanship, toonami\n\n4️⃣ appdash appdash, toonami\n\n5️⃣ appdash app",
"finalZhPrompt": "## 重要的词语\n**appdash** (1.00) **appdash** (0.79)，以专家级(0.01) **绘画技巧** (0.09) 的风格，委托(0.08) 制作，飘渺的(0.05)，梦幻般的(0.02) 质感(0.01)，达达主义的(0.01)，**toonami** (0.19)\n\n██████████ appdash\n████████░░ appdash\n██░░░░░░░░ toonami\n█░░░░░░░░░ draftsmanship\n█░░░░░░░░░ commission\n█░░░░░░░░░ ethereal\n## 简化的提示\n1️⃣ appdash appdash，绘画技巧，委托制作，飘渺，toonami\n\n2️⃣ appdash appdash，绘画技巧，委托制作，toonami\n\n3️⃣ appdash appdash，绘画技巧，toonami\n\n4️⃣ appdash appdash，toonami\n\n5️⃣ appdash appdash"
}
// ...
}
```
### **`/mj/submit/shorten`** **prompt分析**
```json
{
"prompt": "️appdash appdash, in the style of expert draftsmanship, commission for, ethereal, dreamlike quality, dadaistic, toonami"
}
```
后续任务完成后，properties中finalPrompt即为分析结果，finalZhPrompt为翻译的中文
```json
{
"id":"1689252749098647",
"action":"SHORTEN",
"status": "SUCCESS",
"description":"/shorten appdash appdash, in the style of expert draftsmanship, commission for, ethereal, dreamlike quality, dadaistic, toonami",
"properties": {
"finalPrompt": "## Important tokens\n**appdash** **appdash**, in the ~~style~~ of ~~expert~~ **draftsmanship**, commission for, ethereal, dreamlike quality, ~~dadaistic~~, **toonami**\n## Shortened prompts\n1️⃣ appdash appdash, draftsmanship, commission for, ethereal, toonami\n\n2️⃣ appdash appdash, draftsmanship, commission, toonami\n\n3️⃣ appdash appdash, draftsmanship, toonami\n\n4️⃣ appdash appdash, toonami\n\n5️⃣ appdash appdash",
"finalZhPrompt": "## 重要词汇\n**appdash** **appdash**，以专家的绘画风格，委托制作，飘渺的，梦幻般的质感，达达主义的，**toonami**\n## 简化提示\n1️⃣ appdash appdash，绘画风格，委托制作，飘渺的，toonami\n\n2️⃣ appdash appdash，绘画风格，委托制作，toonami\n\n3️⃣ appdash appdash，绘画风格，toonami\n\n4️⃣ appdash appdash，toonami\n\n5️⃣ appdash appdash"
}
// ...
}
```
对该任务执行 `Show Details` 动作，能获得进一步的分析结果
```json
{
"id":"1689253263953453",
"action":"SHORTEN",
"status": "SUCCESS",
"description":"/up 168925266642808397 Show Details",
"properties": {
"finalPrompt": "## Important tokens\n**appdash** (1.00) **appdash** (0.79), in the style (0.01) of expert (0.00) **draftsmanship** (0.09), commission (0.08) for, ethereal (0.05), dreamlike (0.02) quality (0.01), dadaistic (0.01), **toonami** (0.19)\n\n██████████ appdash\n████████░░ appdash\n██░░░░░░░░ toonami\n█░░░░░░░░░ draftsmanship\n█░░░░░░░░░ commission\n█░░░░░░░░░ ethereal\n## Shortened prompts\n1️⃣ appdash appdash, draftsmanship, commission for, ethereal, toonami\n\n2️⃣ appdash appdash, draftsmanship, commission, toonami\n\n3️⃣ appdash appdash, draftsmanship, toonami\n\n4️⃣ appdash appdash, toonami\n\n5️⃣ appdash app",
"finalZhPrompt": "## 重要的词语\n**appdash** (1.00) **appdash** (0.79)，以专家级(0.01) **绘画技巧** (0.09) 的风格，委托(0.08) 制作，飘渺的(0.05)，梦幻般的(0.02) 质感(0.01)，达达主义的(0.01)，**toonami** (0.19)\n\n██████████ appdash\n████████░░ appdash\n██░░░░░░░░ toonami\n█░░░░░░░░░ draftsmanship\n█░░░░░░░░░ commission\n█░░░░░░░░░ ethereal\n## 简化的提示\n1️⃣ appdash appdash，绘画技巧，委托制作，飘渺，toonami\n\n2️⃣ appdash appdash，绘画技巧，委托制作，toonami\n\n3️⃣ appdash appdash，绘画技巧，toonami\n\n4️⃣ appdash appdash，toonami\n\n5️⃣ appdash appdash"
}
// ...
}
```
### **获取任务图片的seed**
绘图任务执行后，不会设置seed，如需获取seed，需要执行 `/mj/task/{id}/image-seed`⚠️ 注意: 必须配置账号的Midjourney Bot私信ID，否则无法调用
* code=1: 获取成功，result为图片对应的seed
```json
{
"code": 1,
"description": "成功",
"result": "636646138"
}
```
* other: 执行错误，description为错误描述
### **任务变更回调**
任务状态变化或进度改变时，会调用业务系统的接口
* 接口地址为配置的 mj.notify-hook，任务提交时支持传`notifyHook`以改变此任务的回调地址
* 两者都为空时，不触发回调
POST application/json
```json
{
"id": "14001929738841620",
"action": "IMAGINE",
"status": "SUCCESS",
"prompt": "猫猫",
"promptEn": "Cat",
"description": "/imagine 猫猫",
"submitTime": 1689231405854,
"startTime": 1689231442755,
"finishTime": 1689231544312,
"progress": "100%",
"imageUrl": "https://cdn.discordapp.com/attachments/xxx/xxx/xxxx.png",
"failReason": null,
"properties": {
"finalPrompt": "Cat"
},
"buttons": []
}
```
### 第三方插件如何接入
只需要在设置里面填入我们的接口地址和令牌即可，他们都是通用的
接口地址：
| 推荐使用以下平台或者插件： |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ChatBoxAI（[打开](https://web.chatboxai.app/)）：一个支持图片上传和插件使用的聊天平台 |
| ChatGPTNext（[打开](https://ai.evanora.top/)）：优秀的网页ChatGPT客户端，无需下载 |
| ChatGPT Sidebar（[打开](https://chrome.google.com/webstore/detail/sider-chatgpt-sidebar-%20-v/difoiogjjojoaoomphldepapgpbgkhkb)）：集成各大搜索引擎，帮助您快速搜索的浏览器插件（接口后面不能有斜杆） |
| vscode-chatgpt-plugin（[打开](https://marketplace.visualstudio.com/items?itemName=xcy960815.vscode-chatgpt-plugin)）：vscode的ChatGPT集成插件，帮助您快速修改代码，支持集成本站API |