Roboflow API キーの見つけ方

Roboflow API と Roboflow Inference で認証するための API キーを見つけます

APIキーは次の場所で見つけることができます app.roboflow.com/settings/api

---

APIキーには2種類あります：

• プライベート APIキー：Roboflow API と Roboflow Inference で使用されます

• 公開 / 発行可能な APIキー：次で使用されます inference.js 、当社の JavaScript 推論 SDK

APIキーはワークスペース単位で管理されるため、そのワークスペースのプライベートプロジェクトにアクセスするには、該当ワークスペースに関連付けられた APIキーを使用する必要があります。

「新しいキーを生成」をクリックして新しいキーを発行するか、すでに作成済みのキーをコピーしてください。

プライベート APIキーは必ず秘密に保ってください。パスワードのように扱ってください。保持者にワークスペースのデータとモデルへのアクセス権を与えます。

もし誤って、あなたのワークスペースにアクセス権のない相手にキーを公開してしまった場合は、「APIキーをロール」をクリックしてください。以前の APIキーは無効化され、新しいキーが作成されます。

複数の APIキー

Enterprise プランのワークスペースでは複数の APIキーを作成できるため、環境を分離し、本番ワークフロー全体に影響を与えることなく、特定のデプロイや担当者のアクセス権を即座に取り消せます。

Enterprise ワークスペース向けの複数 APIキーのオプション

また、 スコープ付き API キー を Enterprise のお客様向けのアドオンとして提供しています。

Roboflow Inference でキーを使用する

APIキーを使うと、Roboflow で学習したモデル、Roboflow Universe 上の公開モデル、およびホスト型推論 API にアクセスできます。 Roboflow Inference.

環境変数

推奨される方法は、 ROBOFLOW_API_KEY を環境変数として設定することです。ほとんどのターミナルでは次のようにします：

export ROBOFLOW_API_KEY=YOUR_API_KEY

そのターミナルセッションで実行された任意のコマンドは、そのキーにアクセスできます。 環境変数 は CLI と SDK が読み取るその他の変数です。

Python

Python から Inference を使用する場合、キーはキーワード引数として渡せます：

from inference import get_model

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

キーが環境に設定されている場合は、引数として渡す必要はありません： model = get_model(model_id="...").

HTTP リクエストのペイロード

サーバーを直接呼び出す場合は、ルートに応じて、キーを URL パラメータとして、またはリクエストペイロードの一部として渡してください：

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 コンテナでローカル実行する場合は、次の docker run コマンドでキーを指定してください：

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

そのサーバーへのリクエストでは api_key をリクエストペイロードから省略できます。

セルフホスト型サーバーでは、デフォルトでは APIキーは不要です。コンテナ内でキーを設定しても、誰がサーバーを呼び出せるかは制限されません。詳しくは セルフホスト型サーバーの保護 を参照して認証を強制してください。