Roboflow Docs
DashboardResourcesProducts
  • Documentation
  • Developer Reference
  • Changelog
  • Developer Tools
  • Authentication
  • Command Line Interface (CLI)
    • Using the CLI
    • Installation and Authentication
    • Download dataset
    • Upload Dataset
    • Run inference
    • Getting help
  • REST API
    • REST API Structure
    • Workspace and Project IDs
    • Workspaces
  • Workspace Image Query
  • Projects
    • Initialize
    • Project Folders API
    • Create
  • Batches
  • Annotation Jobs
  • Images
    • Upload Images
    • Image Details
    • Upload Dataset
    • Upload an Annotation
    • Search
    • Tags
  • Versions
    • Create a Project Version
    • View a Version
  • Train a Model
  • Export Data
  • Inference
  • Annotation Insights
    • Annotation Insights (Legacy Endpoint)
  • Model Monitoring
    • Stats
    • Custom Metadata
  • Python SDK
    • Using the Python SDK
  • iOS SDK
    • Using the iOS SDK
Powered by GitBook
On this page
  • API Route Conventions
  • Authenticate with the API, CLI, and SDKs

Was this helpful?

Developer Tools

NextAuthentication

Last updated 10 hours ago

Was this helpful?

Roboflow offers four developer-centric methods through which you can interact with our product and run inference:

The REST API and Python SDK provide the widest range of features for interacting with Roboflow.

We recommend using the Python SDK if you are working with Roboflow and running inference on models hosted on Roboflow in Python. If you are using iOS, we recommend using the iOS SDK.

The CLI, while offering a more limited set of functionalities, is especially useful for uploading images and annotations, providing a concise command line-driven experience for this task.

API Route Conventions

For the most part, routes in the API follow the same naming conventions as those in the web app. This means, oftentimes, you can simply change the domain from app.roboflow.com to api.roboflow.com and add your api_key to the URL and receive the information corresponding to that resource in JSON format.

Authenticate with the API, CLI, and SDKs

Review the page for information on how to authenticate with the API, CLI, and SDKs.

You can use the Roboflow CLI and API to interact with the Roboflow platform with your command line and in your code.

REST API
Python SDK
CLI
iOS SDK
Authentication