छवि निर्माण API दस्तावेज़
KozeAI ओपनएआई शैली के छवि निर्माण और संपादन इंटरफ़ेस प्रदान करता है। छवि इंटरफ़ेस एक समान छवि प्रतिक्रिया प्रारूप लौटाता है, लेकिन विशिष्ट मॉडल-समर्थित आकार, गुणवत्ता, संदर्भ छवि और आउटपुट प्रारूप चैनल एडाप्टर द्वारा निर्धारित किए जाते हैं।
प्रमाणीकरण
सभी अनुरोध Authorization: Bearer के माध्यम से प्रमाणित होते हैं।
export KOZEAI_API_KEY='sk-your-token'
export KOZEAI_BASE_URL='https://your-kozeai-domain'
API अवलोकन
<टेबल> <शीर्षक>/v1/images/generationsapplication/json/v1/chat/completions
के माध्यम से भी कॉल किया जा सकता है। चैट इंटरफ़ेस टेक्स्ट और संदेशों से छवियों को निकालेगा और फिर उन्हें छवि इंटरफ़ेस प्रारूप में परिवर्तित करेगा; सीधे कनेक्ट करते समय ऊपर दिए गए समर्पित छवि इंटरफ़ेस का उपयोग करने की अनुशंसा की जाती है।1. चित्र
curl '$KOZEAI_BASE_URL/v1/images/generations' \
-H 'Authorization: Bearer $KOZEAI_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
'model': 'gpt-image-1',
'prompt': 'खिड़की के पास बैठी एक नारंगी बिल्ली, सिनेमाई प्रकाश और छाया',
'n': 1,
'size': '1024x1024',
'quality': 'auto',
'response_format': 'url'
}
अनुरोध पैरामीटर
<टेबल> <शीर्षक>मॉडल/v1/models से प्राप्त रिटर्न पर आधारित हैं। प्रॉम्प्टn1, सामान्य सत्यापन सीमा 1-10 है।आकारqualitystandard, hd, auto, 2k, 4k।response_formaturl या b64_json।styleuser / user_idextra_fieldsआउटपुट_फॉर्मेटआउटपुट_कंप्रेशनआंशिक_इमेजवॉटरमार्कवॉटरमार्क_सक्षमछविDALL·E आकार और डिफ़ॉल्ट
| मॉडल | अनुमत आकार मान | डिफ़ॉल्ट |
|---|---|---|
dall-e-2 / dall-e |
256x256、512x512、1024x1024 |
1024x1024 |
1024x1024、1024x1792、1792x1024 |
1024x1024 |
|
gpt-image-1 / gpt-image-2 |
अपस्ट्रीम मॉडल द्वारा निर्धारित | quality=auto |
size उपयोग करना आवश्यक है आधे चौड़ाई वाले अक्षरों x का प्रयोग करें, गुणन चिह्न × का प्रयोग न करें।
2. छवि संपादन
मानक संपादन अनुरोधों में बहुभाग फ़ॉर्म का उपयोग किया जाता है, जिसमें छवि फ़ील्ड का नाम image होता है।
image या image[] का उपयोग करके एकाधिक इनपुट छवियों का पुन: उपयोग किया जा सकता है।
curl '$KOZEAI_BASE_URL/v1/images/edits' \
-H 'Authorization: Bearer $KOZEAI_API_KEY' \
-F 'model=gpt-image-1' \
-F 'prompt=Change the background to night scene and retain subject details' \
-F 'image=@./input.png' \
-F 'n=1' \
-F 'quality=standard'
सामान्य फ़ॉर्म फ़ील्ड्स:
<टेबल> <शीर्षक>छवि / छवि[]मास्कn1, सीमा 1-10।आकारगुणवत्ताresponse_formaturl या b64_json।watermarkकुछ चैनल JSON एडिट रिक्वेस्ट को भी सपोर्ट करते हैं, जैसे image को डेटा URL या इमेज URL पर सेट करना; हालांकि, OpenAI, Codex और ChatGPT OAuth एडिट पाथ मुख्य रूप से मल्टीपार्ट का उपयोग करते हैं।
3. चैनल अंतर
<टेबल> <शीर्षक>आकार के लिए सख्त सत्यापन है।आकार को आस्पेक्ट_रेशियो और रिज़ॉल्यूशन में परिवर्तित किया जाएगा; response_format डिफ़ॉल्ट रूप से b64_json होता है। aspect_ratio और resolution जैसे अतिरिक्त JSON पैरामीटर समर्थित हैं। size 1:1, 16:9, 9:16, 4:3 और 3:4 के आस्पेक्ट रेशियो को सपोर्ट करता है; quality=2k/4k स्केलिंग प्रक्रिया शुरू करता है। संदर्भ छवियां image के माध्यम से अपलोड की जाती हैं। size का उपयोग आस्पेक्ट रेशियो मैपिंग के लिए किया जाता है; quality=hd उच्च रिज़ॉल्यूशन का चयन करेगा; संदर्भ छवि मिश्रण प्रक्रिया में प्रवेश करेगी। input_fidelity, mask, stream, output_format, output_compression, partial_images का समर्थन करता है। model, prompt, n का उपयोग करता है और छवियों को संपादित करता है; अन्य छवि मापदंडों को अनदेखा किया जा सकता है। response_format केवल url या b64_json का समर्थन करता है, डिफ़ॉल्ट url है; संपादन अनुरोधों के लिए कम से कम एक छवि आवश्यक है। सार्वजनिक फ़ील्ड में परिभाषित नहीं किए गए पैरामीटर स्वचालित रूप से पास होने की गारंटी नहीं है। केवल संबंधित चैनल एडॉप्टर द्वारा स्पष्ट रूप से पढ़े गए अतिरिक्त पैरामीटर ही प्रभावी होंगे।
4. प्रतिक्रिया प्रारूप
{
"created": 1751000000,
"data": [
{
"url": "https://example.com/generated.png",
"b64_json": "",
"revised_prompt": "खिड़की के पास बैठी एक नारंगी बिल्ली, सिनेमाई प्रकाश और छाया"
}
]
}
जब `response_format=b64_json` का उपयोग किया जाता है, तो छवि सामग्री `data[].b64_json` में स्थित होती है; URL प्रारूप का उपयोग करने पर, छवि पता `data[].url` में स्थित होता है। विभिन्न चैनल अप्रयुक्त फ़ील्ड के लिए खाली स्ट्रिंग लौटा सकते हैं।
5. जावास्क्रिप्ट कॉल उदाहरण
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: 'सफेद पृष्ठभूमि पर एक न्यूनतम उत्पाद चित्रण',
n: 1, size: 1024x1024,
response_format: url,
}),
});
if (!response.ok) {
throw new Error(await response.text());
}
const result = await response.json();
console.log(result.data[0].url || result.data[0].b64_json);
6. सामान्य त्रुटियाँ
मॉडल आवश्यक है: मॉडल का नाम नहीं दिया गया है।प्रॉम्प्ट आवश्यक है: प्रॉम्प्ट शब्द खाली है।n 1 और 10 के बीच होना चाहिए: जनरेशन की मात्रा सार्वजनिक सीमा से अधिक है।आकार इनमें से एक होना चाहिए...: DALL·E एक असमर्थित आकार का उपयोग करता है।छवि आवश्यक है: संपादन इंटरफ़ेस ने कोई छवि अपलोड नहीं की है या कोई पहचानने योग्य छवि संदर्भ प्रदान नहीं किया है।असमर्थित ... प्रतिक्रिया प्रारूप: लक्ष्य चैनल अनुरोधित आउटपुट प्रारूप का समर्थन नहीं करता है।