Rate Limiter¶
Class: RateLimiterBlockV1
Source: inference.core.workflows.core_steps.flow_control.rate_limiter.v1.RateLimiterBlockV1
The Rate Limiter block controls the execution frequency of a branch within a Workflow by enforcing a cooldown period. It ensures that the connected steps do not run more frequently than a specified interval, helping to manage resource usage and prevent over-execution.
Block usage¶
Rate Limiter is useful when you have two blocks that are directly connected, as shown below:
--- input_a --> ┌───────────┐ ┌───────────┐ --- input_b --> │ step_1 │ --> output_a --> │ step_2 │ --- input_c --> └───────────┘ └───────────┘
If you want to throttle the Step 2 execution rate - you should apply rate limiter in between:
-
keep the existing blocks configuration as is (do not change connections)
-
set
depends_onreference of Rate Limiter intooutput_a -
set
next_stepsreference to be a list referring to[$steps.step_2] -
adjust
cooldown_secondsto specify what is the number of seconds that must be awaited before next time whenstep_2is fired
Cooldown limitations
Current implementation of cooldown is limited to video processing - using this block in context of a
Workflow that is run behind HTTP service (Roboflow Hosted API, Dedicated Deployment or self-hosted
inference server) will have no effect for processing HTTP requests.
Type identifier¶
Use the following identifier in step "type" field: roboflow_core/rate_limiter@v1to add the block as
as step in your workflow.
Properties¶
| Name | Type | Description | Refs |
|---|---|---|---|
name |
str |
Enter a unique identifier for this step.. | ❌ |
cooldown_seconds |
float |
The minimum number of seconds between allowed executions.. | ❌ |
The Refs column marks possibility to parametrise the property with dynamic values available
in workflow runtime. See Bindings for more info.
Available Connections¶
Compatible Blocks
Check what blocks you can connect to Rate Limiter in version v1.
- inputs:
Triangle Visualization,Image Threshold,Single-Label Classification Model,Detections Stitch,Pixelate Visualization,YOLO-World Model,Time in Zone,Data Aggregator,Keypoint Detection Model,Cache Set,Roboflow Dataset Upload,Line Counter,Local File Sink,Circle Visualization,Google Vision OCR,Segment Anything 2 Model,Path Deviation,Blur Visualization,VLM as Classifier,Crop Visualization,Delta Filter,SIFT Comparison,Line Counter Visualization,Ellipse Visualization,Pixel Color Count,Distance Measurement,Twilio SMS Notification,Continue If,Dominant Color,Byte Tracker,Classification Label Visualization,Gaze Detection,CSV Formatter,Property Definition,Rate Limiter,Absolute Static Crop,Qwen2.5-VL,SIFT,Detections Stabilizer,Trace Visualization,CLIP Embedding Model,Multi-Label Classification Model,Stitch Images,Time in Zone,Detections Classes Replacement,Line Counter,QR Code Detection,Identify Outliers,Byte Tracker,Camera Calibration,Image Preprocessing,Perspective Correction,Label Visualization,Velocity,Cache Get,Color Visualization,Roboflow Custom Metadata,Image Contours,Detections Transformation,Polygon Visualization,Llama 3.2 Vision,Dynamic Zone,Clip Comparison,Bounding Rectangle,Mask Visualization,Instance Segmentation Model,Anthropic Claude,Object Detection Model,Dot Visualization,Barcode Detection,Multi-Label Classification Model,Detections Consensus,Model Comparison Visualization,CogVLM,Byte Tracker,Keypoint Visualization,First Non Empty Or Default,Cosine Similarity,Identify Changes,Google Gemini,Detections Filter,OCR Model,LMM,Background Color Visualization,Relative Static Crop,SIFT Comparison,Stitch OCR Detections,Dimension Collapse,Template Matching,Buffer,VLM as Classifier,Image Convert Grayscale,Image Blur,Halo Visualization,Environment Secrets Store,Single-Label Classification Model,JSON Parser,Path Deviation,Object Detection Model,Stability AI Image Generation,VLM as Detector,Dynamic Crop,Clip Comparison,Polygon Zone Visualization,Roboflow Dataset Upload,Detection Offset,Model Monitoring Inference Aggregator,LMM For Classification,OpenAI,Florence-2 Model,Keypoint Detection Model,Size Measurement,Webhook Sink,Grid Visualization,Image Slicer,Reference Path Visualization,Image Slicer,Instance Segmentation Model,Stability AI Inpainting,Camera Focus,Florence-2 Model,VLM as Detector,Corner Visualization,OpenAI,Expression,Email Notification,Slack Notification,Bounding Box Visualization - outputs: None
Input and Output Bindings¶
The available connections depend on its binding kinds. Check what binding kinds
Rate Limiter in version v1 has.
Bindings
Example JSON definition of step Rate Limiter in version v1
{
"name": "<your_step_name_here>",
"type": "roboflow_core/rate_limiter@v1",
"cooldown_seconds": 1.0,
"depends_on": "$steps.model",
"next_steps": [
"$steps.upload"
],
"video_reference_image": "$inputs.image"
}