EasyXAI 文档
API 接入OpenAI 协议

Image Generation

POST https://api.easyx.ai/v1/images/generations
Authorization: Bearer easyx_ws_xxx
Content-Type: application/json

图片生成

curl https://api.easyx.ai/v1/images/generations \
  -H "Authorization: Bearer easyx_ws_xxx" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "gpt-image-1",
  "prompt": "一只戴着贝雷帽的小海獭,水彩风格。",
  "n": 1,
  "size": "1024x1024"
}'

生成参数

参数类型必填说明
modelstring是图片模型名称。
promptstring是图片内容描述或编辑指令,长度限制随模型而不同。
ninteger否生成数量;部分模型只接受 1。
sizestring否输出尺寸,例如 1024x1024、1536x1024、1024x1536;可用尺寸由模型决定。
qualitystring否输出质量;GPT Image 类模型通常使用 auto、high、medium、low,其他模型可使用不同枚举。
response_formatstring否支持该参数的模型可选择 url 或 b64_json;部分图片模型固定返回 base64。
backgroundstring否支持该参数的模型可设 auto、opaque 或 transparent。透明背景需要支持透明通道的输出格式。
output_formatstring否支持该参数的模型可设置 png、jpeg 或 webp。
output_compressioninteger否JPEG / WebP 的压缩质量,支持范围由模型决定。
moderationstring否支持该参数的模型可设置 auto 或 low。
stylestring否支持该参数的模型可设置 vivid 或 natural。
userstring否终端用户标识。

响应

URL 结果

{
  "created": 1741569952,
  "data": [
    {
      "url": "https://example.com/generated-image.png",
      "revised_prompt": "一只戴贝雷帽的小海獭。"
    }
  ]
}

Base64 结果

{
  "created": 1741569952,
  "data": [
    {
      "b64_json": "BASE64_IMAGE"
    }
  ],
  "usage": {
    "input_tokens": 50,
    "output_tokens": 100,
    "total_tokens": 150
  }
}

成功响应

所有三个端点都返回包含图片对象列表的响应。

created

  • 类型:整数
  • 说明:响应创建的时间戳

data

  • 类型:数组
  • 说明:生成的图片对象列表

usage(部分模型返回)

  • 类型:对象
  • 说明:API 调用的 token 使用情况
    • total_tokens:使用的总 token 数
    • input_tokens:输入使用的 token 数
    • output_tokens:输出使用的 token 数
    • input_tokens_details:输入 token 的详细信息(文本 token 和图像 token)

图片对象

b64_json

  • 类型:字符串
  • 说明:如果 response_format 为 b64_json,则包含生成图片的 base64 编码 JSON

url

  • 类型:字符串
  • 说明:如果 response_format 为 url(默认),则包含生成图片的 URL

revised_prompt

  • 类型:字符串
  • 说明:如果提示有任何修改,则包含用于生成图片的修改后的提示

示例图片对象:

{
  "url": "https://...",
  "revised_prompt": "一只可爱的小海獭在水中嬉戏,它有着圆圆的眼睛和毛茸茸的皮毛"
}

读取图片结果

import base64
from pathlib import Path

# response is the parsed JSON response
for index, image in enumerate(response["data"]):
    if image.get("b64_json"):
        Path(f"image-{index}").write_bytes(base64.b64decode(image["b64_json"]))
    elif image.get("url"):
        print(image["url"])

Python SDK

pip install openai
from openai import OpenAI

client = OpenAI(api_key="easyx_ws_xxx", base_url="https://api.easyx.ai/v1")

result = client.images.generate(
    model="gpt-image-1",
    prompt="A sea otter wearing a red beret",
)
print(result.data)

Node.js SDK

npm install openai
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "easyx_ws_xxx",
  baseURL: "https://api.easyx.ai/v1",
});

const result = await client.images.generate({
  model: "gpt-image-1",
  prompt: "A sea otter wearing a red beret",
});
console.log(result.data);

OpenAI Images reference