Tài liệu API tạo ảnh
KozeAI cung cấp giao diện tạo và chỉnh sửa ảnh theo kiểu OpenAI. Giao diện ảnh trả về định dạng phản hồi ảnh thống nhất, nhưng kích thước, chất lượng, ảnh tham chiếu và định dạng đầu ra cụ thể được mô hình hỗ trợ sẽ do bộ điều hợp kênh xác định.
Xác thực
Tất cả các yêu cầu đều được xác thực thông qua Authorization: Bearer .
export KOZEAI_API_KEY='sk-your-token'
export KOZEAI_BASE_URL='https://your-kozeai-domain'
Tổng quan về API
| Phương thức | Đường dẫn | Loại nội dung | Mục đích | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| POST | /v1/images/generations |
application/json |
Văn bản được tạo tự động Hình ảnh | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Tham số | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
mẫu |
chuỗi | Là | Tên mẫu hình ảnh. Các mẫu có sẵn thực tế dựa trên kết quả trả về từ /v1/models. |
lời nhắc |
chuỗi | Có | Mô tả nội dung hình ảnh. Nên sử dụng chuỗi không rỗng. |
n |
số nguyên | Không | Số lượng phần tử được tạo, mặc định là 1, phạm vi xác thực thông thường là 1-10. |
kích thước |
chuỗi | Không | Kích thước hình ảnh hoặc tỷ lệ khung hình, giá trị cụ thể được xác định bởi mô hình. |
chất lượng |
chuỗi | Không | Mức chất lượng, giá trị thông thường là standard, hd, auto, 2k, 4k. |
response_format |
string | No | Các giá trị phổ biến là url hoặc b64_json. |
style |
any | No | Tham số kiểu tương thích với OpenAI. |
user / user_id |
any | No | Mã định danh người dùng gọi. |
extra_fields |
object | No | Tham số cấu trúc bổ sung; Hiệu quả của nó phụ thuộc vào bộ chuyển đổi kênh. |
nền |
bất kỳ | Không | Cài đặt nền. |
kiểm duyệt |
bất kỳ | Không | Cài đặt kiểm duyệt nội dung. |
định dạng đầu ra |
bất kỳ | Không | Định dạng hình ảnh đầu ra. |
output_compression |
integer | No | Tham số nén đầu ra, được hỗ trợ bởi một số mô hình hình ảnh Codex. |
partial_images |
integer | No | Một số tham số liên quan đến hình ảnh/truyền phát, được hỗ trợ bởi một số mô hình hình ảnh Codex. |
watermark |
boolean | No | Công tắc watermark, hiệu quả của nó phụ thuộc vào kênh. |
watermark_enabled |
any | No | Tương thích với một số tham số watermark của nguồn dữ liệu. |
image |
string/object/array | No | Tham chiếu đến URL hình ảnh, URL dữ liệu hoặc đối tượng hình ảnh; Một số kênh sẽ tự động vào quá trình chỉnh sửa. |
Kích thước và cài đặt mặc định của DALL·E
| Mẫu | kích thước Được phép Giá trị |
Mặc định |
|---|---|---|
dall-e-2 / dall-e |
256x256、512x512、1024x1024 |
1024x1024 |
1024x1024、1024x1792、1792x1024 |
1024x1024 |
|
gpt-image-1 / gpt-image-2 |
Được xác định bởi mô hình thượng nguồn | quality=auto |
size Phải sử dụng chữ cái nửa chiều rộng x, không sử dụng dấu nhân ×.
2. Chỉnh sửa ảnh
Các yêu cầu chỉnh sửa tiêu chuẩn sử dụng biểu mẫu đa phần, với trường hình ảnh được đặt tên là image. Có thể sử dụng lại nhiều hình ảnh đầu vào bằng cách sử dụng image hoặc image[].
curl '$KOZEAI_BASE_URL/v1/images/edits' \
-H 'Authorization: Bearer $KOZEAI_API_KEY' \
-F 'model=gpt-image-1' \
-F 'prompt=Thay đổi nền thành cảnh đêm và giữ lại chi tiết chủ thể' \
-F 'image=@./input.png' \
-F 'n=1' \
-F 'quality=standard'
Biểu mẫu chung
Các trường:| Trường | Loại | Mô tả |
|---|---|---|
model |
string | Mô hình chỉnh sửa ảnh. |
prompt |
string | Yêu cầu chỉnh sửa. |
image / image[] |
file | Nhập ít nhất một ảnh. |
mask |
file | Hình ảnh mặt nạ; Chủ yếu được sử dụng cho các quy trình chỉnh sửa tương thích với OpenAI/Codex. |
n |
số nguyên | Số lượng phần tử được tạo ra, mặc định 1, phạm vi 1-10. |
kích thước |
chuỗi | Kích thước hoặc tỷ lệ đầu ra. |
chất lượng |
chuỗi | Chất lượng đầu ra. |
response_format |
string | url hoặc b64_json, tùy thuộc vào kênh. |
watermark |
boolean | Công tắc watermark, tùy thuộc vào kênh. |
Một số kênh cũng hỗ trợ các yêu cầu chỉnh sửa JSON, chẳng hạn như đặt image thành URL dữ liệu hoặc URL hình ảnh; tuy nhiên, các đường dẫn chỉnh sửa OAuth của OpenAI, Codex và ChatGPT ưu tiên sử dụng multipart.
3. Sự khác biệt giữa các kênh
| Kênh | Các hành vi bổ sung |
|---|---|
| OpenAI / DALL·E | Được chuyển tiếp bởi trường hình ảnh OpenAI; DALL·E có xác thực nghiêm ngặt cho kích thước. |
| xAI | kích thước sẽ được chuyển đổi thành tỷ lệ khung hình và độ phân giải; định dạng phản hồi mặc định là b64_json. Các tham số JSON bổ sung như tỷ lệ khung hình và độ phân giải được hỗ trợ. |
| Flow | size Hỗ trợ tỷ lệ khung hình 1:1, 16:9, 9:16, 4:3 và 3:4; quality=2k/4k kích hoạt quá trình thu phóng. Hình ảnh tham chiếu được tải lên thông qua image. |
| Jimeng / Dreamina | size được sử dụng để ánh xạ tỷ lệ khung hình; quality=hd sẽ chọn độ phân giải cao hơn; hình ảnh tham chiếu sẽ được đưa vào quá trình hòa trộn. |
| Codex | Hỗ trợ thêm các tham số input_fidelity, mask, stream, output_format, output_compression, partial_images. |
| ChatGPT OAuth | Thực tế sử dụng các tham số model, prompt, n và chỉnh sửa hình ảnh; các tham số hình ảnh khác có thể bị bỏ qua. |
| Grok | response_format Chỉ hỗ trợ url hoặc b64_json, mặc định là url; yêu cầu chỉnh sửa cần ít nhất một hình ảnh. |
Các tham số không được định nghĩa trong các trường công khai không được đảm bảo tự động truyền qua. Chỉ các tham số bổ sung được bộ điều hợp kênh tương ứng đọc rõ ràng mới có hiệu lực.
4. Định dạng phản hồi
{
"created": 1751000000,
"data": [
{
"url": "https://example.com/generated.png",
"b64_json": "",
"revised_prompt": "Một con mèo màu cam ngồi bên cửa sổ, ánh sáng và bóng tối điện ảnh"
}
]
}
Khi `response_format=b64_json`, nội dung hình ảnh nằm trong `data[].b64_json`; khi sử dụng định dạng URL, địa chỉ hình ảnh nằm trong `data[].url`. Các kênh khác nhau có thể trả về chuỗi rỗng cho các trường không được sử dụng.
5. Ví dụ về lệnh gọi JavaScript
const baseURL = process.env.KOZEAI_BASE_URL;
const apiKey = process.env.KOZEAI_API_KEY;
const response = await fetch(`${baseURL}/v1/images/generations`, {
method: `POST`,
headers: {
Authorization: `Bearer ${apiKey}`,
`Content-Type`: `application/json`,
},
body: JSON.stringify({
model: `gpt-image-1`,
prompt: `Hình minh họa sản phẩm tối giản trên nền trắng`,
n: 1, size: 1024x1024,
response_format: url,
}),
});
if (!response.ok) {
throw new Error(await response.text());
} console.log(result.data[0].url || result.data[0].b64_json);
6. Lỗi thường gặp
model is required: Tên mô hình không được truyền vào.prompt is required: Từ nhắc trống.n must be between 1 and 10: Số lượng tạo vượt quá giới hạn công khai.size must be one of ...: DALL·E sử dụng kích thước không được hỗ trợ.image is required: Giao diện chỉnh sửa không tải lên hình ảnh hoặc không cung cấp tham chiếu hình ảnh có thể nhận dạng được.Định dạng phản hồi không được hỗ trợ...: Kênh đích không hỗ trợ định dạng đầu ra được yêu cầu.