> 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](/reference/hi/platform/python-sdk.md) और [CLI](/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 URLs उसी पदानुक्रम का पालन करते हैं:

* `/:workspace` - वर्कस्पेस में प्रोजेक्ट सूचीबद्ध करता है, साथ ही वर्कस्पेस मेटाडेटा.
* `/:workspace/:project` - किसी प्रोजेक्ट का मेटाडेटा और वर्शन सूची.
* `/:workspace/:project/:version` - किसी विशिष्ट डेटासेट वर्शन, उसका मॉडल (यदि प्रशिक्षित हो), और डाउनलोड URLs.
* `/: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` कॉल्स के अनुरोध बॉडी में पास करना पुराना तरीका है: यह अभी भी काम करता है, लेकिन कुंजी को URLs और लॉग्स में रखता है, इसलिए नए कोड के लिए यह अनुशंसित नहीं है। देखें [REST API के साथ प्रमाणित करें](/reference/hi/platform/rest-api/authenticate-with-the-rest-api.md) विवरण के लिए और [स्कोप्ड API कीज़](/reference/hi/authentication/authentication/scoped-api-keys.md) प्रति-संसाधन स्कोप संदर्भ के लिए।

## त्रुटियाँ

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