API Hop दस्तावेज़
OpenAI मल्टीमोडल Responses
OpenAI-संगत Responses API। यह एंडपॉइंट OpenAI-शैली input इस्तेमाल करता है और पाठ, सार्वजनिक चित्र URL, PDF फ़ाइल इनपुट, टूल कॉल, तर्क-विचार विकल्प तथा स्ट्रीमिंग पैरामीटर समर्थित करता है।
https://api.apihop.ai/openai/responsesOpenAI-संगत Responses API। यह एंडपॉइंट OpenAI-शैली input इस्तेमाल करता है और पाठ, सार्वजनिक चित्र URL, PDF फ़ाइल इनपुट, टूल कॉल, तर्क-विचार विकल्प तथा स्ट्रीमिंग पैरामीटर समर्थित करता है।
POST https://api.apihop.ai/openai/responsesप्रमाणीकरण
सभी अनुरोधों में Bearer Token प्रमाणीकरण आवश्यक है।
Authorization: Bearer YOUR_API_KEYअनुरोध बॉडी
modelstringआवश्यकडिफ़ॉल्ट: gpt-5.4Responses समर्थन वाले वर्तमान सक्रिय मॉडल:
gpt-5.4gpt-5.5gpt-5.6-solgpt-5.6-terragpt-6-astra
वर्तमान API कुंजी को दिखने वाले मॉडल के लिए मॉडल कैटलॉग देखें।
inputstring | object[]इनपुट सामग्री। खाली न होने वाला previous_response_id न दिया हो तो आवश्यक है। दोनों फ़ील्ड छोड़ने या अमान्य इनपुट प्रकार से बिलिंग से पहले 400 लौटता है।
समर्थित रूप:
- स्ट्रिंग, जो एक
userटेक्स्ट इनपुट के बराबर है। - बातचीत इतिहास, मल्टीमोडल इनपुट और टूल कॉल परिणामों के लिए इनपुट आइटम की ऐरे।
इनपुट ऐरे के हर ऑब्जेक्ट में नीचे के फ़ील्ड हो सकते हैं:
typestringइनपुट आइटम प्रकार।
सामान्य मान:
message: संदेश इनपुट।function_call_output: फ़ंक्शन टूल कॉल का परिणाम।
rolestringtype=message होने पर भूमिका।
सामान्य मान:
developersystemuserassistant
contentstring | object[]संदेश सामग्री।
मल्टीमोडल अनुरोध में सामग्री-ब्लॉक ऐरे लें। सामग्री ब्लॉक में समर्थित हैं:
typestringसामग्री ब्लॉक प्रकार।
फिलहाल समर्थित:
input_textinput_imageinput_file
textstringtype=input_text होने पर टेक्स्ट सामग्री।
image_urlstringtype=input_image होने पर सार्वजनिक चित्र URL।
केवल सार्वजनिक रूप से पहुँच योग्य http:// या https:// चित्र URL समर्थित हैं। data:image/...;base64,... जैसे Base64 Data URL समर्थित नहीं हैं।
detailstringडिफ़ॉल्ट: autotype=input_image होने पर चित्र विवरण स्तर।
सामान्य मान:
autolowhigh
file_datastringtype=input_file होने पर फ़ाइल सामग्री Data URL। PDF में data:application/pdf;base64,... इस्तेमाल कर सकते हैं।
filenamestringtype=input_file होने पर फ़ाइल नाम।
instructionsstringमॉडल संदर्भ में जोड़े गए सिस्टम या डेवलपर निर्देश।
max_output_tokensintegerवैकल्पिक अधिकतम आउटपुट टोकन, धनात्मक पूर्णांक के रूप में। चुने मॉडल का अपस्ट्रीम डिफ़ॉल्ट लेने के लिए फ़ील्ड छोड़ें। मॉडल के अनुसार बजट में अंतिम पाठ के साथ तर्क-विचार टोकन भी हो सकते हैं। छोटा बजट उत्तर काट सकता है या अंतिम पाठ से पहले खर्च हो सकता है; बढ़ाने से लागत बढ़ सकती है।
streambooleanडिफ़ॉल्ट: falseउत्तर स्ट्रीम करना है या नहीं।
false: एक पूरा उत्तर लौटाएँtrue: OpenAI Responses-शैली SSE इवेंट लौटाएँ
temperaturenumberडिफ़ॉल्ट: 1.0सैंपलिंग तापमान, आम तौर पर 0 से 2।
top_pnumberडिफ़ॉल्ट: 1.0Nucleus सैंपलिंग पैरामीटर, आम तौर पर 0 से 1।
textobjectटेक्स्ट आउटपुट कॉन्फ़िगरेशन।
text.formatobjectटेक्स्ट प्रारूप कॉन्फ़िगरेशन, जैसे { "type": "text" } या JSON स्कीमा।
text.verbositystringआउटपुट विस्तार स्तर, जैसे low, medium या high। समर्थन चुने मॉडल पर निर्भर है।
toolsobject[]टूल परिभाषाएँ। उपलब्धता चुने मॉडल और उपलब्ध सुविधाओं पर निर्भर है।
tool_choicestring | objectटूल चयन नीति।
parallel_tool_callsbooleanसमानांतर टूल कॉल अनुमत हैं या नहीं।
reasoningobjectतर्क-विचार संबंधी विकल्प।
includestring[]उत्तर में शामिल करने वाले अतिरिक्त फ़ील्ड।
prompt_cache_keystringप्रॉम्प्ट कैश दोबारा इस्तेमाल करने की कुंजी।
prompt_cache_retentionstringप्रॉम्प्ट कैश रखने की नीति। समर्थित मान चुने मॉडल और उपलब्ध सुविधाओं पर निर्भर हैं।
safety_identifierstringसुरक्षा नियंत्रण के लिए स्थिर अंतिम-उपयोगकर्ता पहचान।
storebooleanउत्तर की स्थिति सहेजी जा सकती है या नहीं।
मॉडल पैरामीटर में अंतर
- मूल OpenAI-संगत Responses फ़ॉरवर्डिंग अपस्ट्रीम अनुरोध में
top_pरखती है; सत्यापन और सैंपलिंग व्यवहार चुने मॉडल और अपस्ट्रीम पर निर्भर हैं। 2026-09-26 की जाँचों मेंgpt-5.5,gpt-5.6-solऔरgpt-5.6-terraके लिएtop_p: 0.9स्वीकार हुआ। स्वीकृति और फ़ॉरवर्डिंग सैंपलिंग प्रभाव या दूसरे मान, मॉडल अथवा बाद के अनुरोधों के समर्थन की गारंटी नहीं। न्यूनतम अनुरोध से शुरू करें। - इस पृष्ठ का समर्थन केवल सामान्य
/openai/responsesएंडपॉइंट पर लागू है। इससे उसी मॉडल में/openai/responses/compact, WebSocket या स्थिति-सहितprevious_response_idका समर्थन नहीं माना जा सकता। - ऊपर के पाँच GPT मॉडल का फिलहाल सत्यापित Compact चैनल नहीं है। स्पष्ट चालू चैनल न हो तो Compact अनुरोध बिलिंग से पहले अस्वीकार होते हैं। सामान्य Responses और Responses WebSocket उपलब्ध रहते हैं।
अनुरोध उदाहरण
नीचे के उदाहरण input देते हैं। वैध previous_response_id देने और चुने चैनल में स्थिति-सहित निरंतरता समर्थित होने पर आगे की बातचीत में input छोड़ा जा सकता है। उत्तर ID असमर्थित चैनल पर यह क्षमता चालू नहीं करती। टूल परिणाम वैध इनपुट आइटम रहते हैं, जिनमें function_call_output भी है।
टेक्स्ट
{
"model": "gpt-5.4",
"input": "Hello, introduce yourself in one sentence."
}Codex CLI-शैली पैरामीटर
{
"model": "gpt-5.5",
"input": "Reply with READY only.",
"reasoning": {
"effort": "xhigh"
},
"store": false,
"text": {
"verbosity": "low"
},
"stream": true
}चित्र समझ
{
"model": "gpt-5.4",
"input": [
{
"type": "message",
"role": "user",
"content": [
{
"type": "input_text",
"text": "What is in this image?"
},
{
"type": "input_image",
"image_url": "https://example.com/cat.png",
"detail": "high"
}
]
}
]
}फ़ाइल इनपुट
PDF सामग्री भेजने के लिए file_data के साथ filename दें। file_data पूरा Data URL होना चाहिए।
{
"model": "gpt-5.4",
"input": [
{
"type": "message",
"role": "user",
"content": [
{
"type": "input_text",
"text": "Summarize the key points in this PDF."
},
{
"type": "input_file",
"file_data": "data:application/pdf;base64,JVBERi0xLjQKJc...",
"filename": "report.pdf"
}
]
}
]
}चित्र और फ़ाइल इनपुट
{
"model": "gpt-5.4",
"input": [
{
"type": "message",
"role": "user",
"content": [
{
"type": "input_text",
"text": "Give three conclusions based on the image and attachment."
},
{
"type": "input_image",
"image_url": "https://example.com/chart.png",
"detail": "high"
},
{
"type": "input_file",
"file_data": "data:application/pdf;base64,JVBERi0xLjQKJc...",
"filename": "notes.pdf"
}
]
}
]
}स्ट्रीमिंग आउटपुट
{
"model": "gpt-5.4",
"stream": true,
"input": [
{
"role": "user",
"content": [
{
"type": "input_text",
"text": "Explain this diagram step by step."
},
{
"type": "input_image",
"image_url": "https://example.com/diagram.png"
}
]
}
]
}उत्तर
नॉन-स्ट्रीमिंग उत्तर OpenAI Responses शैली अपनाते हैं। वास्तविक फ़ील्ड चुने मॉडल की क्षमताओं से बदल सकते हैं।
idstringउत्तर की अद्वितीय पहचान।
objectstringउत्तर ऑब्जेक्ट प्रकार, आम तौर पर response।
created_atintegerनिर्माण टाइमस्टैम्प।
modelstringवास्तव में इस्तेमाल मॉडल।
outputobject[]आउटपुट आइटम सूची। सामान्य आइटम में message, function_call और टूल-संबंधी आउटपुट हैं।
usageobjectटोकन उपयोग आँकड़े, जैसे input_tokens, output_tokens और total_tokens।
सफलता उदाहरण
{
"id": "resp_123",
"object": "response",
"created_at": 1766534400,
"model": "gpt-5.4",
"output": [
{
"type": "message",
"role": "assistant",
"content": [
{
"text": "The image shows a cat, and the attachment is a document about pet care."
}
]
}
],
"usage": {
"input_tokens": 128,
"output_tokens": 42,
"total_tokens": 170
}
}स्ट्रीमिंग उत्तर
stream=true होने पर एंडपॉइंट Server-Sent Events लौटाता है।
event: response.output_text.delta
data: {"type":"response.output_text.delta","delta":"The image"}
event: response.completed
data: {"type":"response.completed","response":{"id":"resp_123"}}response.completed या कनेक्शन बंद होने तक इवेंट पढ़ें।
त्रुटि उत्तर
पूरी कोड सूची, प्रोटोकॉल अंतर और निदान चरणों के लिए त्रुटि कोड और निदान देखें।
प्लेटफ़ॉर्म-निर्मित HTTP त्रुटियाँ error आवरण के बजाय नीचे के समतल फ़ील्ड इस्तेमाल करती हैं। कुछ अपस्ट्रीम त्रुटियाँ मूल संरचना रख सकती हैं; शुरू हो चुकी SSE स्ट्रीम की त्रुटियाँ यह HTTP उत्तर उदाहरण नहीं अपनातीं।
{
"code": 40000,
"message": "Insufficient credit. Required: 30000, Available: 20000",
"type": "api_error"
}ध्यान देने योग्य बातें
Responsesएंडपॉइंट मेंinputहै,messagesनहीं। क्लाइंट केवलmessagesभेजता हो तो/openai/v1/chat/completionsलें।- चित्र इनपुट में
input_imageहै;image_urlसार्वजनिकhttp://याhttps://URL होना चाहिए। चित्रों के लिए Base64 Data URL समर्थित नहीं हैं। - फ़ाइल इनपुट में
input_fileहै। PDF के लिएfile_dataके साथfilenameदें;file_dataपूराdata:application/pdf;base64,...URL होना चाहिए। - ऑडियो इनपुट/आउटपुट, चित्र जनरेशन टूल, फ़ाइल खोज और दूसरी उन्नत क्षमताएँ चुने मॉडल और उपलब्ध सुविधाओं पर निर्भर हैं।
- इस पृष्ठ के फ़ील्ड वर्तमान सार्वजनिक Responses अनुरोध अनुबंध बनाते हैं; सूची से बाहर के फ़ील्ड उपलब्ध न मानें।
/openai/responsesसुझाया सार्वजनिक पथ है।/v1/responsesवही सार्वजनिक अनुरोध और उत्तर अनुबंध अपनाता है।/compat/v1/responsesवही सार्वजनिक अनुरोध और उत्तर अनुबंध अपनाता है।/openai/v1/responsesवही सार्वजनिक अनुरोध और उत्तर अनुबंध अपनाता है।