अपनी Roboflow API Key ढूँढ़ें

Roboflow API और Roboflow Inference के साथ authenticate करने के लिए अपनी API Key ढूँढ़ें

आप अपनी API कुंजी यहाँ पा सकते हैं app.roboflow.com/settings/api

---

API कुंजी के दो प्रकार हैं:

• निजी API कुंजियाँ: Roboflow API और Roboflow इन्फ़रेंस

• सार्वजनिक / प्रकाशित करने योग्य API कुंजी: इसका उपयोग किया जाता है inference.js , हमारा JavaScript इन्फ़रेंस SDK

API कुंजियाँ किसी Workspace के लिए स्कोप की गई होती हैं, जिसका अर्थ है कि आपको उस Workspace के निजी प्रोजेक्ट्स तक पहुँचने के लिए उसी Workspace से संबद्ध API कुंजी का उपयोग करना होगा।

नई कुंजी जारी करने के लिए "Generate New Key" पर क्लिक करें, या अपने द्वारा पहले से बनाई गई कुंजी की प्रतिलिपि बनाएँ।

अपनी निजी API कुंजी को गोपनीय रखना सुनिश्चित करें। इसे पासवर्ड की तरह मानें; यह धारक को आपके workspace के डेटा और मॉडल्स तक पहुँच प्रदान करती है।

यदि आप कभी गलती से अपनी कुंजी किसी ऐसे व्यक्ति के सामने प्रकट कर देते हैं जिसे आपके workspace तक पहुँचने की अनुमति नहीं है, तो "Roll API Key" पर क्लिक करें, जो पिछली API कुंजी को निष्क्रिय कर देगा और एक नई कुंजी बनाएगा।

एकाधिक API कुंजियाँ

Enterprise प्लान वाले Workspaces कई API कुंजियाँ बना सकते हैं, जिससे वे वातावरणों को अलग-थलग कर सकते हैं और अपने पूरे production workflow को बाधित किए बिना विशिष्ट deployments या personnel के लिए पहुँच को तुरंत रद्द कर सकते हैं।

Enterprise Workspaces के लिए एकाधिक API कुंजी विकल्प

हम यह भी प्रदान करते हैं Scoped API keys अपने Enterprise ग्राहकों के लिए एक ऐड-ऑन के रूप में।

अपनी कुंजी का उपयोग Roboflow Inference के साथ करें

आपकी API कुंजी आपको Roboflow पर प्रशिक्षित किए गए मॉडलों, Roboflow Universe पर सार्वजनिक मॉडलों, और होस्ट किए गए inference APIs तक पहुँच प्रदान करती है। इसका उपयोग करते समय इसे प्रदान करने के कई तरीके हैं Roboflow Inference.

पर्यावरण चर

अनुशंसित तरीका है सेट करना ROBOFLOW_API_KEY अपने environment में। अधिकांश टर्मिनलों में:

export ROBOFLOW_API_KEY=YOUR_API_KEY

उस टर्मिनल session में चलाया गया कोई भी command तब कुंजी तक पहुँच रखता है। देखें पर्यावरण चर उन अन्य variables के लिए जिन्हें CLI और SDK पढ़ते हैं।

Python

Python से Inference का उपयोग करते समय, कुंजी को keyword argument के रूप में पास किया जा सकता है:

from inference import get_model

model = get_model(model_id="...", api_key="YOUR_API_KEY")

यदि कुंजी आपके environment में सेट है, तो आपको इसे argument के रूप में पास करने की आवश्यकता नहीं है: model = get_model(model_id="...").

HTTP अनुरोध payload

सर्वर को सीधे कॉल करते समय, route के अनुसार, कुंजी को URL parameter के रूप में या request payload के भाग के रूप में पास करें:

import requests

my_api_key = "YOUR_API_KEY"

url = f"http://localhost:9001/soccer-players-5fuqs/1?api_key={my_api_key}"
response = requests.post(url)

url = "http://localhost:9001/infer/object_detection"
payload = {
    "api_key": my_api_key,
    "model_id": "soccer-players-5fuqs/1",
}
response = requests.post(url, json=payload)

Docker

यदि आप Inference Server को स्थानीय रूप से Docker container में चलाते हैं, तो कुंजी को docker run कमांड में दें:

docker run -it --rm --network=host -e ROBOFLOW_API_KEY=YOUR_API_KEY roboflow/roboflow-inference-server-cpu:latest

उस server को भेजे गए अनुरोध तब api_key को request payload से छोड़ सकते हैं।

एक self-hosted server को डिफ़ॉल्ट रूप से API key की आवश्यकता नहीं होती। container में एक सेट करने से यह प्रतिबंधित नहीं होता कि server को कौन कॉल कर सकता है: देखें स्व-होस्टेड सर्वर को सुरक्षित करना प्रमाणीकरण लागू करने के लिए।