roboflow-api-reference について
Roboflow APIを扱う開発者向けのリファレンススキルです。ホスト、認証、SDK、タスク別のエンドポイント選択に加え、MCPツールとREST呼び出しの使い分けを説明します。
主な機能
- 01タスク別のAPIホスト比較
- 02認証方式の確認
- 03PythonまたはJavaScript SDKの選択
- 04推論・管理エンドポイントの選択
活用シーン
- 01モデル推論用のホスト選択
- 02APIキー認証の設定
- 03連携に使うSDKの選択
MCP 対応
プロジェクト、モデル、ワークフロー、画像の操作にはRoboflow MCPツールを推奨し、MCPを使わない場合のRESTパターンも説明します。
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ roboflow/ computer-vision-skills --skill roboflow-api-referenceインストール後、Claude Code で/roboflow-api-referenceを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
api-key-management.mdinference.mdrest-api.md詳細
エージェント向け: このスキルは
roboflow/computer-vision-skillsで作成されています。クライアントにスキルとしてすでに読み込まれている場合(たとえば Roboflow プラグインから読み込まれている場合)は、そのコピーを使用してください。roboflow://skills/<name>/...MCP リソースは、スキルが読み込まれていないクライアント向けに同じスキルを提供します。
ヒント: Roboflow MCP サーバーに接続している場合は、REST を直接呼び出すよりも、そのツール(
projects_*、versions_*、models_*、workflows_*、images_*、…)を優先してください。認証、ページネーション、型付きレスポンスを処理してくれます。以下の REST のパターンは、MCP を使用しない場合に引き続き役立ちます。
Roboflow API リファレンス — 概要
API ホスト
| ホスト | ベース URL | 用途 |
|---|---|---|
| Platform API | https://api.roboflow.com | プロジェクト、画像、バージョン、トレーニング、アップロードの CRUD |
| Serverless Inference | https://serverless.roboflow.com | モデル推論と Workflow の実行 |
| Dedicated Deployment | https://<name>.roboflow.cloud | プライベート GPU 推論(serverless と同じ API) |
| Self-hosted Inference | http://localhost:9001 | inference パッケージを介したローカル推論サーバー |
すべての推論ホストで、推奨クライアントとして inference-sdk Python パッケージを使用してください。認証、再試行、レスポンスの解析を処理します。
認証
| 方法 | 場所 | 形式 |
|---|---|---|
| クエリパラメーター | すべてのホスト | ?api_key=YOUR_KEY |
| リクエストボディ | Platform API + Workflow 推論 | JSON ボディ内の "api_key": "YOUR_KEY" |
| ヘッダー | MCP サーバー(mcp.roboflow.com) | x-api-key: YOUR_KEY(MCP が自動的に処理) |
API キーはワークスペース単位です。Roboflow ダッシュボード(app.roboflow.com/{workspace}/settings/api)の Workspace Settings > API Keys から取得してください。個人用 API キーは /settings/account → API Keys タブにあります。
SDK
| SDK | インストール | 主な用途 |
|---|---|---|
Python(inference-sdk) | pip install inference-sdk | InferenceHTTPClient による推論 |
Python(roboflow) | pip install roboflow | アップロード、トレーニング、プロジェクト管理 |
JavaScript(roboflow.js) | ブラウザの script タグ | リアルタイムのオンデバイス Web 推論 |
| iOS(Swift) | CocoaPods/SPM | オンデバイスのモバイル推論 |
Python inference-sdk クイックスタート
from inference_sdk import InferenceHTTPClient
CLIENT = InferenceHTTPClient(
api_url="https://serverless.roboflow.com", # or dedicated URL, or localhost
api_key="YOUR_KEY"
)
result = CLIENT.infer("image.jpg", model_id="your-project/1")
Python roboflow SDK クイックスタート
import roboflow
rf = roboflow.Roboflow(api_key="YOUR_KEY")
project = rf.workspace("my-workspace").project("my-project")
# Upload
project.upload(image_path="image.jpg", split="train")
# Inference
model = project.version(1).model
result = model.predict("image.jpg", confidence=40).json()
ホスト選択ガイド
| タスク | 使用するホスト |
|---|---|
| モデル推論の実行 | serverless.roboflow.com |
| Workflows の実行 | serverless.roboflow.com |
| 画像のアップロード | api.roboflow.com |
| プロジェクト/バージョンの管理 | api.roboflow.com |
| トレーニングの開始 | api.roboflow.com |
| 高スループット/SLA 対応の推論 | Dedicated deployment URL |
| エアギャップ環境/オンプレミスでの推論 | セルフホストの localhost:9001 |
| リアルタイム動画/Web カメラ/RTSP | serverless またはローカル環境に対する inference_sdk.webrtc 経由の WebRTC — roboflow://skills/roboflow-inference/workflows(「Video Stream」セクション)を参照してください。通常の HTTP 呼び出しではありません。 |
レート制限
- Serverless API:レート制限はプランによって異なります
- ファイルの最大アップロードサイズ:20 MB
関連ページ
roboflow://skills/roboflow-api-reference/inference— 推論 URL のパターン、リクエスト/レスポンス形式roboflow://skills/roboflow-api-reference/rest-api— Platform REST API のエンドポイント(CRUD、アップロード、トレーニング)roboflow://skills/roboflow-api-reference/api-key-management— REST、MCP ツール、Python CLI を使用した API キーの作成と管理。キーを作成する際、ワークスペースで Advanced API Keys が利用できる場合は、最小限の権限にスコープを設定してください。 利用できない場合は、スコープ付きキーは Enterprise の機能であることをユーザーに伝えてください。