REST API

Roboflow REST API होस्ट, संसाधन पदानुक्रम, root endpoint, और प्रमाणीकरण विधियों का अवलोकन।

Roboflow REST API प्लेटफ़ॉर्म का आधिकारिक इंटरफ़ेस है - हर फ़ीचर सबसे पहले यहीं आता है, और Python SDK और CLI दोनों पर्दे के पीछे इसे कॉल करते हैं। जब आप कोई गैर-Python इंटीग्रेशन बना रहे हों, वेबहुक या ब्राउज़र से कॉल कर रहे हों, या ऐसे वातावरण में काम कर रहे हों जहाँ Python पैकेज इंस्टॉल नहीं किए जा सकते, तब सीधे REST API का उपयोग करें।

जानने योग्य दो बेस होस्ट हैं:

होस्ट	के लिए उपयोग होता है
https://api.roboflow.com	प्रबंधन - वर्कस्पेस, प्रोजेक्ट, वर्ज़न, ट्रेनिंग, वर्कफ़्लोज़, डेटासेट, विज़न इवेंट्स, ट्रैश।
https://serverless.roboflow.com	होस्टेड इन्फ़रेंस - किसी प्रशिक्षित मॉडल या वर्कफ़्लो को किसी इमेज या वीडियो पर चलाना। देखें किसी इमेज पर मॉडल चलाएँ.

डेडिकेटेड डिप्लॉयमेंट्स का प्रबंधन तीसरे होस्ट (https://roboflow.cloud).

संसाधन पदानुक्रम

Roboflow डेटा मॉडल पदानुक्रमिक है और API URL उसी पदानुक्रम का अनुसरण करते हैं:

• /:workspace - किसी वर्कस्पेस में प्रोजेक्ट्स की सूची, साथ ही वर्कस्पेस मेटाडेटा।

• /:workspace/:project - किसी प्रोजेक्ट का मेटाडेटा और वर्ज़न सूची।

• /:workspace/:project/:version - डेटासेट का कोई विशिष्ट वर्ज़न, उसका मॉडल (यदि प्रशिक्षित हो), और डाउनलोड URL।

• /:workspace/:project/:version/:format - किसी डेटासेट को किसी विशिष्ट एक्सपोर्ट फ़ॉर्मेट.

• /:workspace/workflows/:workflow - देखें वर्कफ़्लोज़ प्रबंधित करें.

• /:workspace/groups - प्रोजेक्ट फ़ोल्डर्स। देखें प्रोजेक्ट फ़ोल्डर्स प्रबंधित करें.

• /:workspace/trash - सॉफ्ट-डिलीट किए गए प्रोजेक्ट, वर्ज़न, और वर्कफ़्लोज़। देखें ट्रैश प्रबंधित करें.

रूट एंडपॉइंट

शीर्ष स्तर पर (https://api.roboflow.com/), आप सत्यापित कर सकते हैं कि आपका api_key काम कर रहा है। प्रतिक्रिया उस वर्कस्पेस की पहचान करती है जिससे आपकी कुंजी संबंधित है:

curl "https://api.roboflow.com/?api_key=$ROBOFLOW_API_KEY"

{
  "welcome": "Roboflow API में आपका स्वागत है.",
  "instructions": "आपका सफलतापूर्वक प्रमाणीकरण हो गया है.",
  "docs": "https://docs.roboflow.com",
  "workspace": "my-workspace"
}

वहाँ से, आगे जाएँ वर्कस्पेस और प्रोजेक्ट्स सूचीबद्ध करें यह देखने के लिए कि वर्कस्पेस में क्या है।

प्रमाणीकरण और स्कोप

API कुंजियाँ वर्कस्पेस-स्कोप्ड होती हैं। कुंजी को क्वेरी पैरामीटर के रूप में पास करें (?api_key=...), अनुरोध बॉडी में POST कॉल्स के लिए, या Authorization: Bearer ... हेडर के रूप में। देखें REST API से प्रमाणीकरण करें विवरण के लिए और स्कोप्ड API कुंजियाँ प्रति-संसाधन स्कोप संदर्भ के लिए।

त्रुटियाँ

API मानक HTTP स्टेटस कोड और एक JSON त्रुटि बॉडी का उपयोग करता है। देखें त्रुटियाँ और स्टेटस कोड क्रॉस-टूल त्रुटि संदर्भ के लिए।