API对接代码示例
我们的服务器位于美国，各位技术人员精选区域相近的服务器以最大程度地避免延时问题，检测地址：https://www.itdog.cn/
Postman是 Post 请求，请各位技术人员使用全路径
原生的http请求使用全路径：/v1/chat/completions
使用OpenAI的依赖请使用：/v1
                                                                                   Python 代码示例（流式输出）
43
import openai

#  pip install openai==0.28
#  如没办法直接安装，请第一步：pip install --upgrade openai，第二步：pip install openai==0.28
# Load your API key from an environment variable or secret management service
openai.api_key = "token"
openai.api_base = "代理地址/v1"

def gptChat():
  response = openai.ChatCompletion.create(
    model='gpt-4',
    messages=[
      {
        'role': 'user',
        'content': "你好"
      }
    ],
    temperature=1,
    stream=True  # 关键在这，开启流式输出
  )

  # create variables to collect the stream of chunks
  collected_chunks = []
  collected_messages = []
  # iterate through the stream of events
  # print('----------下面将会流式输出-------------------')
  for chunk in response:
    collected_chunks.append(chunk)
    chunk_message = chunk['choices'][0]['delta']
    if 'content' in chunk_message:
      collected_messages.append(chunk_message.content)
      print(chunk_message.content, end='')  # 将流式输出打印出来
# print('-------------下面是完整的输出内容------------')
# full_reply_content = ''.join([ m for m in collected_messages])
# print(full_reply_content)


if __name__ == '__main__':
  i = 0
  for i in range(1):
    gptChat()
    print(i)
请求参数说明：
1.请求方式：POST
2.openai.api_key：您的API 密钥，用于验证请求的有效性。
3.openai.api_base：这是您要请求的 URL。
4.openai.ChatCompletion.create：该函数用于创建新的聊天完成请求。参数包括：
a.model：模型名称。
b.messages：包含消息的列表，每个消息是一个字典，包含：
i.role：发送消息的角色，可以是'user'、'system'或'assistant'。
ii.content：消息内容。
c.temperature：控制输出随机性的参数。高值导致输出更随机，低值使输出更确定。
d.stream：一个布尔值，决定是否使用流式输出。如果为 True，则响应将是流式输出。
5.frequency_penalty：此参数可以调控生成文本中词语的常见性。高值（接近1）会产生更多不常见的词语，低值（接近0）则会产生常见词语。
6.presence_penalty：此参数调控文本中新信息的量。高值（接近1）会产生更多新的、尚未提及的信息，低值（接近0）则会产生已提到的信息。
7.top_p：此参数控制生成文本的随机性。高值（接近1）使文本产生更多可能性，而低值（接近0）会让模型偏向于选择最可能的输出。
注意：gpt-4-all、gpts都可以使用此对接代码示例，并没有特殊的对接代码示例，并且4、5、6请求参数可以不带。
                                        Python 代码示例（无需OpenAI依赖）
44
# 此代码示例不需要依赖于openai的依赖，即可对接成功
import requests
import json

API_KEYS_AND_URLS = [
  {"key": "token", "url": "代理地址/v1/chat/completions"},
]

def get_gpt4_response(question):
  data = {
    "model": "gpt-4-1106-preview",
    "stream": False,
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": question}
    ]
  }

  for api in API_KEYS_AND_URLS:
    api_key = api["key"]
    api_endpoint = api["url"]
    headers = {
      "Authorization": f"Bearer {api_key}",
      "Content-Type": "application/json",
    }

    try:
      response = requests.post(api_endpoint, headers=headers, data=json.dumps(data))
      if response.status_code == 200:

        reply_content = response.json()["choices"][0]["message"]["content"]
        return reply_content
      else:
        print(f"Error {response.status_code}: {response.text}")
    except Exception as e:
      print(f"An error occurred with API key {api_key}: {e}")

  return None

# Example usage
question = question = "问题"
response = get_gpt4_response(question)
print(response)
                                                DALLE-3（绘画）代码示例
10
curl 代理地址/v1/images/generations \
-H "Content-Type: application/json" \
-H "Authorization: key" \
-d '{
      "model": "dall-e-3", # 模型的名称
      "prompt": "A cute baby sea otter", # 图像的描述
      "n": 1, # 生成的图像的数量。注意，目前官方限制只能生成一张图像，但可能会在未来放开这个限制。
      "size": "1024x1024" # 生成的图像的大小
    }'
                                                                       gpt-4-vision-preview（识图模型）代码示例
26
# 请求方式：post
{
  "model":"gpt-4-vision-preview", # 模型名称
  "messages":[
    {
      "role":"user", # 发送消息的角色，可以是'user'、'system'或'assistant'。
      "content":[    # 这是消息的内容，是一个列表，包含以下字段：
        {
          "type":"text", # 这是消息的类型，可以是'text'或'image_url'
          "text":"你好,帮我分析下面的图片中是什么" # 这是消息的文本内容
        },
        {
          "type":"image_url",
          "image_url":   # 这是消息的图片URL。注意，你需要先将图片上传到公网，然后将链接给到GPT。
          {
            "url":"https://img-blog.csdnimg.cn/img_convert/2a388361afd21ca04cbc01e7330f77c6.png" 
          }
        }
      ]
    }
  ],
  "stream":false # false是非流式输出，true是流式输出，建议使用非流输出
  "max_tokens":4096 # 控制输出最大长度的参数
}
注意：禁止使用本代码来对接使用 gpt-4-all 和 gpts 模型， 请求方式：post
                                                                                       TTS-1（文字转语音）代码示例
12
# 请求方式：post
# pip install --upgrade openai
from openai import OpenAI

client = OpenAI(api_key='token', base_url='代理地址/v1')
response = client.audio.speech.create(
  model="tts-1", # 模型名称
  voice="alloy", # 声音名称
  input="Hello world! This is a streaming test.", # 转化为语音的文本
)
response.stream_to_file("output.mp3") #这是一个函数，用于将响应的数据流保存到文件，"output.mp3"：保存的文件的名称
                                                           Json_mode代码示例
16
from openai import OpenAI

client = OpenAI(api_key='token', base_url='代理地址/v1')

response = client.chat.completions.create(
  model="gpt-3.5-turbo-1106", # 目前只适配新模型
  response_format={"type": "json_object"},
  messages=[
    {"role": "system", "content": "You are a helpful assistant designed to output JSON."},
    {"role": "user", "content": "Who won the world series in 2020?"}
  ],
  stream=False
)
# 检查response.headers是否为空
print(response.choices[0].message.content)
💡 请求参数说明：
1.请求方式：POST
2.﻿api_key：用于验证你的请求。
3.﻿base_url：这是API的基础URL。
4.﻿client.chat.completions.create：这是一个函数，用于创建一个新的聊天完成请求。它接受以下参数：
○﻿model：这是你想要使用的模型的名称。
○﻿response_format：这是你想要的响应格式。
○﻿messages：这是一个包含消息的列表。每个消息都是一个字典，包含以下字段：
■﻿role：这是发送消息的角色，可以是'user'或'system'。
■﻿content：这是消息的内容。
○﻿stream：这是一个布尔值，决定是否开启流式输出。如果设置为True，那么响应将会是一个生成器，可以迭代获取输出。在这个例子中，它被设置为False，表示你希望一次性获取所有输出。
5.﻿response：这是API的响应。它是一个对象，包含了API的响应数据。
6.﻿response.choices[0].message.content：这是从响应中获取的第一个选择的消息的内容。
                                                               whisper-1代码示例
12
# 请求方式：POST
curl 代理地址/v1/audio/transcriptions \
-H "Authorization: Bearer APIKEY" \ 
-H "Content-Type: multipart/form-data" \ # 指定请求的内容类型
-F file="@/path/to/file/audio.mp3" \ # 上传的文件
-F model="whisper-1" # 模型名称

回复：
{ 
  "text": "Imagine the wildest idea that you've ever had, and you're curious about how it might scale to something that's a 100, a 1,000 times bigger. This is a place where you can get to do that." # 这是API的响应，表示音频文件被转录为文本后的结果
}
                                                            Gemini-pro
请求URL
2
代理地址/v1/gemini/provision
请求头：
Authorization
sk-xxxx
请求方式：POST
请求入参：
10
{
  "model":"gemini-pro",
    "messages":[
    {
    "role": "user",
      "content": "来个java快排"
      }
  ]
}
响应体：
4
data:{"choices":[{"delta":{"content":"```java\\npublic class QuickSort {\\n\\n    public static void quickSort("}}],"created":1704010355,"model":"gemini-pro"}

data:{"choices":[{"delta":{"content":"int[] arr, int low, int high) {\\n        if (low \\u003c high) {\\n            // pi is partitioning index, arr[pi]"}}],"created":1704010356,"model":"gemini-pro"}↵↵
                                                                                            Gemini-pro-vision
请求URL ：
2
https://代理地址/v1/gemini/provision
请求头：
Authorization
sk-xxxxx
请求方式： POST
请求入参 (可二种方式选一)
方式一 : 提供图片url (图片必须公网可下载)
prompt 入参格式 图片_问答(_为空格)
5
{
  "model":"gemini-pro-vision",
    "prompt":"https://pic3.zhimg.com/v2-c1928e75fd9adc2b2b4064c0402259b6_r.jpg 请你观察这张图"   
}
方式二 : 提供图片的base64
6
{
  "model":"gemini-pro-vision",
  "prompt":"请你描述一下这张图"   
  "base64":"图片"
}
响应体：
12
{
  "choices":[
    {
    "delta":{
      "content":" 图中的女生五官精致，皮肤白皙，身材高挑，气质优雅。她穿着一件黑色的抹胸礼服，佩戴着珍珠项链和耳环，头发盘在脑后，露出修长的脖子。她的右手轻轻抚摸着礼服的蕾丝花边，左手则自然地垂在身体一侧。她的眼神清澈而明亮，嘴角微微上扬，似乎在若有所思。这张图拍摄得非常唯美，光线柔和，色彩鲜艳，将女生的美展现得淋漓尽致。"
        }
  }
  ],
  "created":1704009912,
    "model":"gemini-pro-vision"
}
Midjourney Proxy代码示例
1、提交Imagine（绘图）任务
接口地址：代理地址/mj/submit/imagine﻿
请求方式：POST
请求数据类型：application/json
响应数据类型：*/*
请求示例:
8
{
  "base64Array": [],
  "notifyHook": "",
  "prompt": "Cat",
  "state": ""
}

请求头: 二选一
key
value
Authorization
sk-xxxx
mj-api-secret
sk-xxxx
请求参数:
参数名称
参数说明
请求类型
是否必须
数据类型
schema
base64Array
垫图base64数组
﻿
false
array
string
prompt
提示词
﻿
true
string
﻿
state
自定义参数
﻿
false
string
﻿
响应状态:
状态码
说明
schema
200
OK
﻿
201
Created
﻿
401
Unauthorized
﻿
403
Forbidden
﻿
404
Not Found
﻿
响应参数:
参数名称
参数说明
类型
schema
code
状态码: 1(提交成功), 21(已存在), 22(排队中), other(错误)
integer(int32)
integer(int32)
description
描述
string
﻿
properties
扩展字段
object
﻿
result
任务ID
string
﻿
响应示例:
10
{
	"code": 1,
	"description": "提交成功",
	"result": "1705514776143750",
	"properties": {
		"discordInstanceId": "1146852997121441885"
	}
}

3、指定ID获取任务
接口地址：代理地址/mj/task/{id}/fetch﻿
请求方式：GET
请求数据类型：application/json
响应数据类型：*/*
请求头: 二选一
key
value
Authorization
sk-xxxx
mj-api-secret
sk-xxxx
请求参数:
参数名称
参数说明
请求类型
是否必须
数据类型
schema
id
任务ID
path
false
string
﻿
响应状态:
状态码
说明
schema
200
OK
﻿
401
Unauthorized
﻿
403
Forbidden
﻿
404
Not Found
﻿
响应参数:
参数名称
参数说明
类型
schema
action
可用值,UPSCALE,VARIATION,REROLL,DESCRIBE,BLEND
string
﻿
description
任务描述
string
﻿
failReason
失败原因
string
﻿
finishTime
结束时间
integer(int64)
integer(int64)
id
任务ID
string
﻿
imageUrl
图片url
string
﻿
progress
任务进度
string
﻿
prompt
提示词
string
﻿
promptEn
提示词-英文
string
﻿
startTime
开始执行时间
integer(int64)
integer(int64)
state
自定义参数
string
﻿
status
任务状态,可用值,SUBMITTED,IN_PROGRESS,FAILURE,SUCCESS
string
﻿
submitTime
提交时间
integer(int64)
integer(int64)
响应示例:
28
{
    "code":200,
    "data":{
        "action":"IMAGINE",
        "description":"/imagine a blue cat with red eyes",
        "finishTime":1705514831596,
        "id":"1705514776143750",
        "imageUrl":"<https://cdn.discordapp.com/attachments/1146852997121441885/1197240719769862264/starxmate_bot1_a_blue_cat_with_red_eyes_e620fa4a-d4d1-4887-8815-b1616db11775.png?ex=65ba8c4f&amp;is=65a8174f&amp;hm=f07821509884683400cb1a167aa7b7ba994fb20c3f24d15c2c1064d153427fdd&amp;">,
        "progress":"100%",
        "prompt":"a blue cat with red eyes",
        "promptEn":"a blue cat with red eyes",
        "properties":{
            "discordInstanceId":"1146852997121441885",
            "flags":0,
            "messageId":"1197240720432570521",
            "messageHash":"e620fa4a-d4d1-4887-8815-b1616db11775",
            "nonce":"1468789800118079488",
            "finalPrompt":"a blue cat with red eyes --v 5.0",
            "progressMessageId":"1197240492308566106"
        },
        "startTime":1705514776143,
        "status":"SUCCESS",
        "submitTime":1705514776143
    },
    "message":"OK"
}

4、提交Describe任务
接口地址：代理地址/mj/submit/describe﻿
请求方式：POST
请求数据类型：application/json
响应数据类型：*/*
接口描述:
请求示例:
9
{
  "botType": "MID_JOURNEY",
  "base64": "data:image/png;base64,xxx",
  "notifyHook": "",
  "state": ""
}


请求头: 二选一
key
value
Authorization
sk-xxxx
mj-api-secret
sk-xxxx
请求参数:
参数名称
参数说明
请求类型
是否必须
数据类型
schema
describeDTO
describeDTO
body
true
Describe提交参数
Describe提交参数
botType
bot类型，mj(默认)或niji,可用值:MID_JOURNEY,NIJI_JOURNEY
﻿
false
string
﻿
base64
图片base64
﻿
true
string
﻿
notifyHook
回调地址, 为空时使用全局notifyHook
﻿
false
string
﻿
state
自定义参数
﻿
false
string
﻿
响应状态:
状态码
说明
schema
200
OK
提交结果
201
Created
﻿
401
Unauthorized
﻿
403
Forbidden
﻿
404
Not Found
﻿
响应参数:
参数名称
参数说明
类型
schema
code
状态码: 1(提交成功), 22(排队中), other(错误)
integer(int32)
integer(int32)
description
描述
string
﻿
properties
扩展字段
object
﻿
result
任务ID
string
﻿
响应示例:
9
{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}


5、执行动作
接口地址: 代理地址/mj/submit/action﻿
请求方式：POST
请求数据类型：application/json
响应数据类型：*/*
接口描述:
请求示例:
9
{
  "customId": "MJ::JOB::upsample::2::3dbbd469-36af-4a0f-8f02-df6c579e7011",
  "taskId": "14001934816969359",
  "notifyHook": "",
  "state": ""
}


请求头: 二选一
key
value
Authorization
sk-xxxx
mj-api-secret
sk-xxxx
请求参数:
参数名称
参数说明
请求类型
是否必须
数据类型
schema
customId
动作标识
﻿
true
string
﻿
taskId
任务ID
﻿
true
string
﻿
notifyHook
回调地址, 为空时使用全局notifyHook
﻿
false
string
﻿
state
自定义参数
﻿
false
string
﻿
响应状态:
状态码
说明
schema
200
OK
提交结果
201
Created
﻿
401
Unauthorized
﻿
403
Forbidden
﻿
404
Not Found
﻿
响应参数:
参数名称
参数说明
类型
schema
code
状态码: 1(提交成功), 22(排队中), other(错误)
integer(int32)
integer(int32)
description
描述
string
﻿
properties
扩展字段
object
﻿
result
任务ID
string
﻿
响应示例:
9
{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}


6、提交Blend任务
接口地址: 代理地址/mj/submit/blend﻿
请求方式：POST
请求数据类型：application/json
响应数据类型：*/*
接口描述:
请求示例:
13
{
  "botType": "MID_JOURNEY",
  "base64Array": [
    "data:image/png;base64,xxx1",
    "data:image/png;base64,xxx2"
  ],
  "dimensions": "SQUARE"
  "notifyHook": "",
  "state": ""
}


请求头: 二选一
key
value
Authorization
sk-xxxx
mj-api-secret
sk-xxxx
请求参数:
参数名称
参数说明
请求类型
是否必须
数据类型
schema
botType
bot类型，mj(默认)或niji,可用值:MID_JOURNEY,NIJI_JOURNEY
﻿
false
string
﻿
base64Array
图片base64数组
﻿
true
array
string
dimensions
比例: PORTRAIT(2:3); SQUARE(1:1); LANDSCAPE(3:2),可用值:PORTRAIT,SQUARE,LANDSCAPE
﻿
false
string
﻿
notifyHook
回调地址, 为空时使用全局notifyHook
﻿
false
string
﻿
state
自定义参数
﻿
false
string
﻿
响应状态:
状态码
说明
schema
200
OK
提交结果
201
Created
﻿
401
Unauthorized
﻿
403
Forbidden
﻿
404
Not Found
﻿
响应参数:
参数名称
参数说明
类型
schema
code
状态码: 1(提交成功), 22(排队中), other(错误)
integer(int32)
integer(int32)
description
描述
string
﻿
properties
扩展字段
object
﻿
result
任务ID
string
﻿
响应示例:
9
{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}


7、提交Modal
接口地址: 代理地址/mj/submit/modal﻿
请求方式：POST
请求数据类型：application/json
响应数据类型：*/*
接口描述:
请求示例:
8
{
  "maskBase64": "",
  "prompt": "",
  "taskId": "14001934816969359"
}


请求头: 二选一
key
value
Authorization
sk-xxxx
mj-api-secret
sk-xxxx
请求参数:
参数名称
参数说明
请求类型
是否必须
数据类型
schema
maskBase64
局部重绘的蒙版base64
﻿
false
string
﻿
prompt
提示词
﻿
false
string
﻿
taskId
任务ID
﻿
true
string
﻿
响应状态:
状态码
说明
schema
200
OK
提交结果
201
Created
﻿
401
Unauthorized
﻿
403
Forbidden
﻿
404
Not Found
﻿
响应参数:
参数名称
参数说明
类型
schema
code
状态码: 1(提交成功), 22(排队中), other(错误)
integer(int32)
integer(int32)
description
描述
string
﻿
properties
扩展字段
object
﻿
result
任务ID
string
﻿
响应示例:
9
{
	"code": 1,
	"description": "提交成功",
	"properties": {},
	"result": 1320098173412546
}


﻿
8、上传文件到discord
接口地址: 代理地址/mj/submit/upload-discord-images
请求方式：POST
请求数据类型：application/json
响应数据类型：*/*
接口描述:
请求示例:
4
{
 "base64Array":["data:image/png;base64,iVBORw0KxxxxxxxxxxxxxxxxxCYII="]
}
请求头: 二选一
key
value
Authorization
sk-xxxx
mj-api-secret
sk-xxxx
请求参数:
参数名称
参数说明
请求类型
是否必须
数据类型
schema
base64Array
        base64数组
﻿
true
List<String>
﻿
响应状态:
状态码
说明
schema
200
OK
提交结果
201
Created
﻿
401
Unauthorized
﻿
403
Forbidden
﻿
404
Not Found
﻿
响应参数:
参数名称
参数说明
类型
schema
code
状态码: 1(提交成功), 22(排队中), other(错误)
integer(int32)
integer(int32)
description
描述
string
﻿
properties
扩展字段
object
﻿
result
任务ID
string
﻿
响应示例:
8
{
    "code": 1,
    "description": "成功",
    "result": [
        "https://cdn.discordapp.com/attachments/1217xxxxxxxxxx24ba794b&"
    ]
}
﻿
﻿
﻿
二、部分功能使用示例
1、Modal使用示例(局部重绘)
1.执行Imagine任务，绘画初始作品
代理地址/mj/submit/imagine﻿
﻿﻿
2.根据id查询当前任务的结果
代理地址/mj/task/1710249468818538/fetch﻿
﻿﻿
﻿
3.获取U1按钮的customId，调用执行动作的接口，执行点击U1按钮的动作。此时会返回我们一个新的任务id。
代理地址/mj/submit/action﻿
﻿﻿
﻿
﻿
4.根据新的任务id查询结果，可以看到该任务下面出现了局部重绘的按钮。
代理地址/mj/task/1710249468818538/fetch﻿
﻿
﻿﻿
﻿
5.获取Vary (Region)按钮的customId，调用执行动作的接口，执行点击Vary (Region)按钮的动作。此时会返回我们一个新的任务id，并且我们发现任务也进入了窗口等待状态。
代理地址/mj/submit/action﻿
﻿﻿
6. 如果传入蒙版,则需要自己的前端实现一个蒙版，对原图进行区域选择。操作的数据应该是，底色纯黑，选中区域纯白。下面是 base64 转换工具
﻿base64图片在线转换工具 - 站长工具﻿
﻿﻿
﻿
7.执行modal接口，此时可以传入新的提示词和maskBase64字段，来完成局部重绘功能
﻿﻿
﻿
﻿
8.再次查询该任务的结果，任务已经执行成功
代理地址/mj/task/1710249468818538/fetch﻿
﻿﻿
2、ZOOM (Upscale、Vary)示例
ZOOM
1.执行Imagine任务，绘画初始作品
代理地址/mj/submit/imagine﻿
﻿﻿
2.根据id查询当前任务的结果
﻿﻿
3.获取U1按钮的customId，调用执行动作的接口，执行点击U1按钮的动作。此时会返回我们一个新的任务id
代理地址/mj/submit/action﻿
﻿﻿
4.根据新的任务id查询结果，可以看到该任务下面出现了局部重绘的按钮。
代理地址/mj/task/1710249468818538/fetch﻿
﻿﻿
5.获取Zoom customId 执行action
代理地址/mj/submit/action﻿
﻿
﻿﻿
6.查询任务，发现状态正常，ZOOM执行成功
代理地址/mj/task/1710249468818538/fetch﻿
﻿﻿
3、cref 示例
1.调用上传图片到discord接口
﻿﻿
﻿
2.获取响应回来的图片域名,调用submit/imagine接口,入参参考如下
prompt  --cref  图片url  自定义参数
﻿
你可以使用 --cw 将参考“强度”从 100 修改为 0
强度 100 ( --cw 100 ) 为默认值，会同时参考使用脸部、头发和衣服
强度为 0 ( --cw 0 ) 时，它只会关注脸部（适合更换服装/头发等）
﻿﻿
﻿
3.查询图片
﻿﻿
﻿
﻿