Roboflow Docs
DashboardResourcesProducts
  • Product Documentation
  • Developer Reference
  • Changelog
  • Developer Tools
  • Authentication
    • Find Your Roboflow API Key
    • Scoped API Keys
    • Workspace and Project IDs
  • Command Line Interface (CLI)
    • Using the CLI
    • Installation and Authentication
    • Download a Dataset
    • Upload Dataset
    • Run a Model on an Image
  • REST API
    • REST API Structure
    • Authenticate
    • Workspaces
  • Workspace Image Query
  • Projects
    • Initialize
    • Project Folders API
    • Create
  • Batches
  • Annotation Jobs
  • Images
    • Upload Images
    • Image Details
    • Remove Images
    • 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
  • Authenticate
  • iOS SDK
    • Using the iOS SDK
Powered by GitBook
On this page

Was this helpful?

  1. Authentication

Find Your Roboflow API Key

PreviousDeveloper ToolsNextScoped API Keys

Last updated 12 hours ago

Was this helpful?

To authenticate with the Roboflow API, you need an API key. You can obtain an API key using our web application or via our token issuance flow, supported by the CLI and Python package.

There are two kinds of API key:

  • Private

  • Public

The private API key can be used to run and deploy models and Workflows, and interact with the Roboflow API.

The public API key is exclusively for use with inference.js, our JavaScript inference SDK.

Retrieve an API Key

You can retrieve an API key from your Roboflow settings.

First, go to the . In the left navigation bar, click on "Settings" and then "API Keys":

You will be taken to a page with your API keys. API keys are scoped to a Workspace, which means you must use the API key associated with a workspace to access that Workspace's private projects.

Click "Generate New Key" to issue a new key, or copy a key you have already created.

Be sure to keep your private API key secret. Treat it like a password; it grants the bearer access to your workspace's data and models.

If you ever accidentally expose your key to someone who isn't authorized to access your workspace, click "Revoke API Key". Your API key will be disabled immediately. You can then create a new one.

Roboflow dashboard