Roboflow Docs
DashboardForum
  • Build Vision Models with Roboflow
  • Quickstart
  • Roboflow Enterprise
  • Workspaces
    • Create a Workspace
    • Delete a Workspace
    • Add Team Members
    • Role-Based Access Control
  • Usage Based Pricing
  • Workflows
    • Create a Workflow
    • Build a Workflow
    • Test a Workflow
    • Deploy a Workflow
    • Workflow Examples
      • Multimodal Model Workflow
    • Share a Workflow
      • Workflow Sharing Configuration
    • Advance Workflow Topics
      • JSON Editor
  • Datasets
    • Create a Project
    • Upload Data
      • Import Data from Cloud Providers
        • AWS S3 Bucket
        • Azure Blob Storage
        • Google Cloud Storage
      • Upload Video
      • Import from Roboflow Universe
    • Manage Batches
    • Search a Dataset
    • Create a Dataset Version
    • Preprocess Images
    • Create Augmented Images
    • Add Tags to Images
    • Manage Classes
    • Edit Keypoint Skeletons
    • Create an Annotation Attribute
    • Export Versions
    • Dataset Analytics
    • Merge Projects
    • Delete an Image
    • Delete a Version
    • Delete a Project
    • Project Folders
  • Annotate
    • Annotation Tools
    • Use Roboflow Annotate
      • Annotate Keypoints
      • Label Assist (AI Labeling)
      • Enhanced Smart Polygon with SAM (AI Labeling)
      • Smart Polygon (AI Labeling)
      • Keyboard Shortcuts
      • Comment on an Image
      • Annotation History
      • Similarity Search
      • Box Prompting (AI Labeling)
    • Automated Annotation with Auto Label
    • Collaborate on Annotations
    • Annotation Insights
    • Labeling Best Practices
  • Train
    • Train a Model in Roboflow
      • Train from Scratch
      • Train from a Universe Checkpoint
      • Python Package
      • Roboflow Notebooks (GitHub)
    • Train from Azure Vision
    • Train from Google Cloud
    • View Training Results
    • Evaluate Trained Models
    • Custom Training Notebooks
  • Deploy
    • Deployment Overview
      • Roboflow Managed Deployments Overview
    • Serverless Hosted API
      • Object Detection
      • Classification
      • Instance Segmentation
        • Semantic Segmentation
      • Keypoint Detection
      • Foundation Models
        • CLIP
        • OCR
        • YOLO-World
      • Video Inference
        • Use a Fine-Tuned Model
        • Use CLIP
        • Use Gaze Detection
        • API Reference
        • Video Inference JSON Output Format
      • Pre-Trained Model APIs
        • Blur People API
        • OCR API
        • Logistics API
        • Image Tagging API
        • People Detection API
        • Fish Detection API
        • Bird Detection API
        • PPE Detection API
        • Barcode Detection API
        • License Plate Detection API
        • Ceramic Defect Detection API
        • Metal Defect Detection API
    • Serverless Hosted API V2
    • Dedicated Deployments
      • How to create a dedicated deployment (Roboflow App)
      • How to create a dedicated deployment (Roboflow CLI)
      • How to use a dedicated deployment
      • How to manage dedicated deployment using HTTP APIs
    • SDKs
      • Python inference-sdk
      • Web Browser
        • inferencejs Reference
        • inferencejs Requirements
      • Lens Studio
        • Changelog - Lens Studio
      • Mobile iOS
      • Luxonis OAK
    • Upload Custom Weights
    • Download Roboflow Model Weights
    • Enterprise Deployment
      • License Server
      • Offline Mode
      • Kubernetes
      • Docker Compose
    • Model Monitoring
      • Alerting
  • Roboflow CLI
    • Introduction
    • Installation and Authentication
    • Getting Help
    • Upload Dataset
    • Download Dataset
    • Run Inference
  • API Reference
    • Introduction
    • Python Package
    • REST API Structure
    • Authentication
    • Workspace and Project IDs
    • Workspaces
    • Workspace Image Query
    • Batches
    • Annotation Jobs
    • Projects
      • Initialize
      • Create
      • Project Folders API
    • Images
      • Upload Images
      • Image Details
      • Upload Dataset
      • Upload an Annotation
      • Search
      • Tags
    • Versions
      • View a Version
      • Create a Project Version
    • Inference
    • Export Data
    • Train a Model
    • Annotation Insights
      • Annotation Insights (Legacy Endpoint)
    • Model Monitoring
      • Custom Metadata
      • Inference Result Stats
  • Support
    • Share a Workspace with Support
    • Account Deletion
    • Frequently Asked Questions
Powered by GitBook
On this page
  • Allow people to run a Workflow under your API Key
  • Allow people to run a Workflow under your hidden credentials

Was this helpful?

  1. Workflows
  2. Share a Workflow

Workflow Sharing Configuration

PreviousShare a WorkflowNextAdvance Workflow Topics

Last updated 7 months ago

Was this helpful?

By default, a shared Workflow does not run under your API Keys and credentials. This means that it does not consume your usage limits and replaces any credentials like OpenAI API Key on your blocks as input parameters the user should provide. You can change this behavior by changing sharing configurations:

Allow people to run a Workflow under your API Key

This is useful when you want to share a Workflow containing a private Model - since the default behavior is not to run under your API key, a Workflow containing a private Model will fail to execute - so you change that to allow a protected run: it will affect your usage limits, but your API Key and model data will always be private.

To do so, go to the Run access section and change it to allow anyone to run the Workflow.

This option is only available when a private Model is detected in the workflow steps.

This configuration side effects are:

Any previews run under the shareable link will affect your Wokflow usage.

Your private Models data and your API Key will always remain private.

Allow people to run a Workflow under your hidden credentials

This is useful when you want to share a workflow that has any step with credentials (LMM, OpenAI, Anthropic, etc.) and let people securely use your own credentials to make it easier for them to try your Workflow - your credentials won't be exposed and will be redacted on any client-facing data.

To do so, go to the Credentials section and change it to allow users to execute the Workflow with your hidden credentials.

This option is only available when a step that needs credentials is detected in the workflow.

This configuration side effects are:

Any previews run under the shareable link will affect your specific credential usage limits (e.g. OpenAI Api Keys).

Your credentials values will always be private and are redacted from any client-facing data.

Here's an example of a Workflow that runs under a hidden OpenAI API Key to run a License Plate detection + OCR. Give it a try!

LogoLicense Plate OCRRoboflow
Run Access dropdown options.
Run Access option to allow private models being executed in shareable links.
Credentials configuration dropdwn options.
Credentials option to allow people running a Workflow under your pre-configured credentials.