> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/reference/hi/platform/rest-api.md).

# REST API

Roboflow REST API hosts, resource hierarchy, root endpoint, और authentication methods का अवलोकन।

Roboflow REST API प्लेटफ़ॉर्म का आधिकारिक इंटरफ़ेस है - हर फ़ीचर सबसे पहले यहाँ आता है, और [Python SDK](https://docs.roboflow.com/reference/hi/platform/python-sdk.md) और [CLI](https://docs.roboflow.com/reference/hi/platform/cli.md) दोनों अंदरूनी तौर पर इसे कॉल करते हैं। जब आप कोई गैर-Python इंटीग्रेशन बना रहे हों, वेबहुक या ब्राउज़र से कॉल कर रहे हों, या ऐसे वातावरण में काम कर रहे हों जहाँ Python पैकेज इंस्टॉल नहीं किए जा सकते, तब सीधे REST API का उपयोग करें।

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

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

[डेडिकेटेड डिप्लॉयमेंट्स](https://docs.roboflow.com/deployment/roboflow-cloud/dedicated-deployments#http-api) एक तीसरे होस्ट पर प्रबंधित किए जाते हैं (`https://roboflow.cloud`).

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

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

* `/:workspace` - किसी वर्कस्पेस में प्रोजेक्ट्स की सूची, साथ ही वर्कस्पेस मेटाडेटा।
* `/:workspace/:project` - किसी प्रोजेक्ट का मेटाडेटा और संस्करण सूची।
* `/:workspace/:project/:version` - किसी विशिष्ट डेटासेट संस्करण, उसका मॉडल (यदि प्रशिक्षित हो), और उसके ट्रेनिंग रन।
* `/:workspace/:project/:version/:format` - किसी विशिष्ट डेटासेट को डाउनलोड करें [एक्सपोर्ट फ़ॉर्मेट](https://roboflow.com/formats).
* `/:workspace/workflows/:workflow` - देखें [वर्कफ़्लोज़ प्रबंधित करें](https://docs.roboflow.com/workflows/manage/manage-workflows#http-api).
* `/:workspace/groups` - प्रोजेक्ट फ़ोल्डर। देखें [प्रोजेक्ट फ़ोल्डर प्रबंधित करें](https://docs.roboflow.com/datasets/manage/project-folders#http-api).
* `/:workspace/trash` - सॉफ्ट-डिलीट किए गए प्रोजेक्ट, संस्करण, और वर्कफ़्लोज़। देखें [ट्रैश प्रबंधित करें](https://docs.roboflow.com/platform/workspaces/trash#http-api).

## रूट एंडपॉइंट

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

```bash
curl -H "Authorization: Bearer $ROBOFLOW_API_KEY" "https://api.roboflow.com/"
```

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

वहाँ से, आगे बढ़कर [वर्कस्पेस और प्रोजेक्ट्स सूचीबद्ध करें](https://docs.roboflow.com/platform/workspaces/list-workspaces-and-projects#http-api) ताकि आप देख सकें कि वर्कस्पेस में क्या है।

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

API keys वर्कस्पेस-स्कोप्ड होते हैं। कुंजी को एक `Authorization: Bearer ...` हेडर के रूप में भेजें। इसे क्वेरी पैरामीटर (`?api_key=...`) के रूप में या `POST` कॉल्स के request body में पास करना पुरानी विधि है: यह अभी भी काम करती है, लेकिन कुंजी को URLs और लॉग्स में रखती है, इसलिए नए कोड के लिए इसकी सिफारिश नहीं की जाती। देखें [REST API के साथ प्रमाणित करें](https://docs.roboflow.com/reference/hi/platform/rest-api/authenticate-with-the-rest-api.md) विवरण के लिए और [उन्नत API कुंजियाँ](https://docs.roboflow.com/reference/hi/authentication/authentication/scoped-api-keys.md) प्रति-संसाधन स्कोप संदर्भ के लिए।

## त्रुटियाँ

API मानक HTTP status codes और JSON error body का उपयोग करता है। देखें [त्रुटियाँ और स्थिति कोड](https://docs.roboflow.com/reference/hi/errors-and-status-codes.md) टूल्स-क्रॉस त्रुटि संदर्भ के लिए।
