चैट बनाएँ
दी गई चैट बातचीत के लिए मॉडल प्रतिक्रिया का अनुरोध करता है। स्ट्रीमिंग और नॉन-स्ट्रीमिंग दोनों मोड समर्थित हैं, सभी मॉडल और प्रदाताओं में एक ही OpenAI-संगत अनुरोध/प्रतिक्रिया रूप के साथ।
/api/v1/chat/completionsप्राधिकरण
Authorizationआवश्यकAuthorization हेडर में bearer token के रूप में API कुंजी।
Body
modelआवश्यकउपयोग करने वाला मॉडल, प्रदाता-योग्य, जैसे "openai/gpt-4.1"। सामान्य मॉडल परिवारों के छोटे id (जैसे "gpt-4o") स्वतः पूर्ण canonical id ("openai/gpt-4o") में हल हो जाते हैं; पहले से canonical रूप के मान ज्यों के त्यों गुजरते हैं। अपरिचित छोटे id को जबरन नहीं बदला जाता — मॉडल रिज़ॉल्यूशन चरण स्पष्ट मॉडल-नहीं-मिला त्रुटि लौटाता है।
"openai/gpt-4.1"messagesआवश्यकबातचीत संदेशों की सरणी, कम से कम एक। प्रत्येक में role (system/user/assistant/tool) और content होता है।
modelsफ़ॉलबैक मॉडल सूची — क्रम से आज़माई जाती है, केवल तब उपयोग होती है जब प्राइमरी मॉडल का अपना उम्मीदवार समूह समाप्त हो जाए।
streamtrue होने पर प्रतिक्रिया SSE के रूप में स्ट्रीम होती है; छोड़ने या false पर एकल JSON प्रतिक्रिया मिलती है।
temperatureसैंपलिंग तापमान — जितना अधिक उतना यादृच्छिक, जितना कम उतना नियतात्मक।
max_tokensप्रतिक्रिया द्वारा जनरेट किए जा सकने वाले अधिकतम टोकन की संख्या।
max_completion_tokensmax_tokens का उपनाम, समान अर्थ के साथ।
top_pन्यूक्लियस सैंपलिंग थ्रेशोल्ड।
top_kसैंपलिंग को सबसे अधिक संभावना वाले K टोकन तक सीमित करता है।
frequency_penaltyटोकन को उनके पहले से आने की आवृत्ति के आधार पर दंडित करता है।
presence_penaltyटोकन को इस आधार पर दंडित करता है कि वे कितनी बार भी आए हों, बिना गिनती के।
repetition_penaltyपुनरावृत्ति दंड गुणांक — frequency/presence penalty से अलग तंत्र।
min_pसबसे संभावित टोकन के सापेक्ष न्यूनतम संभावना सीमा।
top_aएक और गतिशील कटऑफ सैंपलिंग तंत्र, जो शीर्ष संभावना के वर्ग से थ्रेशोल्ड को स्केल करता है।
seedनियतात्मक सैंपलिंग सीड; सभी प्रदाता पुनरुत्पादकता की गारंटी नहीं देते।
nजनरेट किए जाने वाले पूर्णताओं की संख्या।
stopअनुक्रम जहाँ जनरेशन रुक जाता है, अधिकतम 4।
toolsटूल/फ़ंक्शन परिभाषाओं की सूची जिन्हें मॉडल कॉल कर सकता है।
tool_choiceनियंत्रित करता है कि मॉडल को टूल कॉल करने के लिए मजबूर किया जाए या नहीं/कैसे।
parallel_tool_callstools प्रदान किए जाने पर समानांतर टूल कॉल की अनुमति दें या नहीं। डिफ़ॉल्ट true। केवल OpenAI-परिवार मॉडल — जब लक्ष्य मॉडल OpenAI का न हो तो यह फ़ील्ड चुपचाप हटा दी जाती है, यह त्रुटि नहीं है।
response_formatआउटपुट फ़ॉर्मेट को सीमित करता है, जैसे {type:"json_object"} या JSON Schema के साथ {type:"json_schema"}।
logit_biasटोकन ID को [-100, 100] बायस मानों से मैप करता है, जो सैंपलिंग से पहले जोड़े जाते हैं। केवल OpenAI-परिवार मॉडल — जब लक्ष्य मॉडल OpenAI का न हो तो यह फ़ील्ड चुपचाप हटा दी जाती है, यह त्रुटि नहीं है।
logprobsप्रत्येक आउटपुट टोकन की लॉग संभावनाएँ लौटाता है। केवल OpenAI-परिवार मॉडल — जब लक्ष्य मॉडल OpenAI का न हो तो यह फ़ील्ड चुपचाप हटा दी जाती है, यह त्रुटि नहीं है।
top_logprobsप्रति स्थिति लौटाए जाने वाले सबसे संभावित टोकन की संख्या (logprobs: true आवश्यक)। केवल OpenAI-परिवार मॉडल — जब लक्ष्य मॉडल OpenAI का न हो तो यह फ़ील्ड चुपचाप हटा दी जाती है, यह त्रुटि नहीं है।
userमॉनिटरिंग और दुरुपयोग पहचान के लिए एंड-यूज़र पहचानकर्ता। बिलिंग पर कोई प्रभाव नहीं। केवल OpenAI-परिवार मॉडल — जब लक्ष्य मॉडल OpenAI का न हो तो यह फ़ील्ड चुपचाप हटा दी जाती है, यह त्रुटि नहीं है।
reasoningरीज़निंग-मॉडल थिंकिंग कंट्रोल ऑब्जेक्ट (जैसे {effort, max_tokens})।
reasoning_effortreasoning.effort के लिए फ़्लैट संक्षिप्त फ़ील्ड।
lowmediumhighimage_configछवि जनरेशन/संपादन विकल्प (जब modalities में image शामिल हो तब उपयोग)।
modalitiesअनुरोधित आउटपुट मोडैलिटी। image शामिल होने पर इमेज-जनरेशन डिस्पैच पथ से गुजरता है।
textimagepluginsप्लगइन सरणी (जैसे वेब सर्च सक्षम करने हेतु {id:"web"})। केवल कुछ मॉडल रूट पर समर्थित, अन्यथा निष्प्रभावी; :online मॉडल वेरिएंट स्वतः {id:"web"} जोड़ता है, वह भी केवल समर्थित रूट पर।