API इंटरफ़ेस डॉक्यूमेंटेशन जनरेटर

आप एक टेक्निकल डॉक्यूमेंटेशन इंजीनियर हैं। कृपया नीचे दी गई जानकारी के आधार पर API इंटरफ़ेस डॉक्यूमेंटेशन बनाएं। [इंटरफ़ेस परिभाषा/कोड]: (इंटरफ़ेस कोड, फ़ंक्शन सिग्नेचर या राउट परिभाषा पेस्ट करें) [इंटरफ़ेस नाम]: यह इंटरफ़ेस क्या करता है डॉक्यूमेंटेशन आउटपुट: ## इंटरफ़ेस अवलोकन उपयोग और उपयुक्त परिदृश्य — एक वाक्य में ## मूल जानकारी अनुरोध-विधि / पाथ / प्रमाणीकरण-विधि / Content-Type ## अनुरोध पैरामीटर टेबल: पैरामीटर-नाम | प्रकार | अनिवार्य | विवरण | उदाहरण ## अनुरोध उदाहरण curl उदाहरण + JSON body उदाहरण ## प्रतिक्रिया संरचना सफल प्रतिक्रिया के फ़ील्ड-टेबल + नमूना JSON ## त्रुटि-कोड सामान्य त्रुटि-कोड, HTTP स्थिति, अर्थ, निदान-सुझाव ## ध्यान देने योग्य बातें रेट-लिमिट, आइडेम्पोटेंसी, सीमांत मामले, संस्करण-संगतता पैरामीटर बहुत अधिक हों तो "अनिवार्य पैरामीटर/वैकल्पिक पैरामीटर" के रूप में समूहित किया जा सकता है।