skillZs
★ LIVE SKILL TAGS ★
>>> LIVE SKILLS INDEX <<<
* OPEN SOURCE *
NO LOGIN, NO TRACKING
※ REAL INSTALL DATA ※
← back to all skills
roboflow/computer-vision-skills361 installs

roboflow-api-reference

Protocol-level facts for Roboflow REST and Inference APIs — URL patterns, auth, parameters, error codes, and SDK quick-start. For deployment strategy and Workflow execution patterns, see roboflow-inference.

How do I install this agent skill?

npx skills add https://github.com/roboflow/computer-vision-skills --skill roboflow-api-reference
view source ↗

Is this agent skill safe to install?

  • Gen Agent Trust Hubpass

    This skill provides a comprehensive API and SDK reference for the Roboflow platform. It covers authentication, project management, and inference workflows while emphasizing security best practices such as least-privilege API key scoping and the avoidance of hardcoded secrets.

  • Socketpass

    No alerts

  • Snykpass

    Risk: LOW · No issues

What does this agent skill do?

For agents: This skill is authored in roboflow/computer-vision-skills. If your client already has it loaded as a skill (for example from a Roboflow plugin), use that copy. The skill://roboflow/<name>/SKILL.md MCP resources serve the same skills for clients that don't have them loaded.

Tip: If you're connected to the Roboflow MCP server, prefer its tools (projects_*, versions_*, models_*, workflows_*, images_*, …) over raw REST calls — they handle auth, pagination, and typed responses for you. The REST patterns below stay relevant if you're not using MCP.

Roboflow API Reference — Overview

API Hosts

HostBase URLPurpose
Platform APIhttps://api.roboflow.comCRUD for projects, images, versions, training, upload
Serverless Inferencehttps://serverless.roboflow.comModel inference + Workflow execution
Dedicated Deploymenthttps://<name>.roboflow.cloudPrivate GPU inference (same API as serverless)
Self-hosted Inferencehttp://localhost:9001Local inference server via inference package

Use the inference-sdk Python package as the preferred client for all inference hosts. It handles auth, retries, and response parsing.

Authentication

MethodWhereFormat
Query parameterAll hosts?api_key=YOUR_KEY
Request bodyPlatform API + Workflow inference"api_key": "YOUR_KEY" in JSON body
HeaderMCP server (mcp.roboflow.com)x-api-key: YOUR_KEY (handled automatically by MCP)

API keys are workspace-scoped. Get yours from Workspace Settings > API Keys in the Roboflow dashboard (app.roboflow.com/{workspace}/settings/api). Personal API keys are at /settings/account → API Keys tab.

SDKs

SDKInstallPrimary Use
Python (inference-sdk)pip install inference-sdkInference via InferenceHTTPClient
Python (roboflow)pip install roboflowUpload, training, project management
JavaScript (roboflow.js)Browser script tagReal-time on-device web inference
iOS (Swift)CocoaPods/SPMOn-device mobile inference

Python inference-sdk Quick Start

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 Quick Start

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()

Host Selection Guide

TaskHost to Use
Run model inferenceserverless.roboflow.com
Run Workflowsserverless.roboflow.com
Upload imagesapi.roboflow.com
Manage projects/versionsapi.roboflow.com
Start trainingapi.roboflow.com
High-throughput / SLA inferenceDedicated deployment URL
Air-gapped / on-prem inferenceSelf-hosted localhost:9001
Real-time video / webcam / RTSPWebRTC via inference_sdk.webrtc against serverless or local — see skill://roboflow/roboflow-inference/workflows.md ("Video Stream" section). Not a plain HTTP call.

Rate Limits

  • Serverless API: rate limits vary by plan
  • File upload max: 20 MB

Related Pages

  • skill://roboflow/roboflow-api-reference/inference.md — inference URL patterns, request/response formats
  • skill://roboflow/roboflow-api-reference/rest-api.md — platform REST API endpoints (CRUD, upload, training)
  • skill://roboflow/roboflow-api-reference/api-key-management.md — creating and managing API keys via REST, MCP tools, and Python CLI. When creating a key, scope it to least privilege if the workspace has Advanced API Keys; if not, tell the user scoped keys are an Enterprise feature.

Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.

<a href="https://skillzs.dev/skills/roboflow/computer-vision-skills/roboflow-api-reference">View roboflow-api-reference on skillZs</a>