mcpField
R
roboflow-api-reference

roboflow-api-reference

github.com/roboflow开发48324 次安装今天更新
代码仓库

关于 roboflow-api-reference

面向 Roboflow API 开发者的参考技能，涵盖主机、身份验证、SDK 和按任务选择端点，并说明 MCP 工具与 REST 调用的适用场景。

主要功能

  1. 01按任务比较 API 主机
  2. 02了解身份验证方式
  3. 03选择 Python 或 JavaScript SDK
  4. 04选择推理与管理端点

适用场景

  1. 01为模型推理选择主机
  2. 02配置 API 密钥身份验证
  3. 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.md
inference.md
rest-api.md

详细介绍

面向 Agent： 此技能由 roboflow/computer-vision-skills 编写。如果客户端已将其作为技能加载（例如通过 Roboflow 插件加载），请使用该副本。roboflow://skills/<name>/... MCP 资源为尚未加载这些技能的客户端提供相同的技能。

提示： 如果已连接到 Roboflow MCP 服务，优先使用其工具（projects_*、versions_*、models_*、workflows_*、images_*，……），而不是直接调用 REST API——这些工具会为你处理身份验证、分页和类型化响应。如果不使用 MCP，下面的 REST 模式仍然适用。

Roboflow API 参考 — 概览

API 主机

主机基础 URL用途
Platform APIhttps://api.roboflow.com项目、图像、版本、训练和上传的 CRUD 操作
Serverless Inferencehttps://serverless.roboflow.com模型推理 + 工作流执行
Dedicated Deploymenthttps://<name>.roboflow.cloud私有 GPU 推理（与 serverless 使用相同的 API）
Self-hosted Inferencehttp://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）浏览器脚本标签实时设备端 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
运行 Workflowsserverless.roboflow.com
上传图像api.roboflow.com
管理项目/版本api.roboflow.com
开始训练api.roboflow.com
高吞吐量 / SLA 推理专用部署 URL
隔离网络 / 本地部署推理自托管 localhost:9001
实时视频 / 网络摄像头 / RTSP通过 inference_sdk.webrtc 使用 WebRTC 连接 serverless 或本地服务——参见 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 功能。

评论

支持 Markdown