Roboflow Visual Search¶
Class: RoboflowVisualSearchBlockV1
Search a Roboflow project for images that look similar to an input image and return the nearest candidate plus metadata.
How This Block Works¶
This block uses the existing Roboflow project image search API:
- Receives an input image from the workflow
- Sends the image to Roboflow project search as
image_base64 - Requests useful fields such as image URL, tags, and user metadata
- Returns the best candidate, best candidate image, metadata, tags, and the top candidates list
The target project should already contain uploaded images. Roboflow indexes those images for visual search using the platform's existing image indexing pipeline. This block does not create images, update metadata, or manage the index.
Type identifier¶
Use the following identifier in step "type" field: roboflow_core/visual_search@v1to add the block as
as step in your workflow.
Properties¶
| Name | Type | Description | Refs |
|---|---|---|---|
name |
str |
Enter a unique identifier for this step.. | ❌ |
workspace |
str |
Roboflow workspace URL slug that owns the target project.. | ✅ |
target_project |
str |
Roboflow project URL slug to search.. | ✅ |
top_k |
int |
Number of visually similar image candidates to return. Use 1 when you only need the nearest candidate.. | ✅ |
The Refs column marks possibility to parametrise the property with dynamic values available
in workflow runtime. See Bindings for more info.
Runtime compatibility¶
-
requires_internet— air-gapped / offline deployments - This block depends on a service that is not reachable from fully offline / air-gapped deployments.
Available Connections¶
Compatible Blocks
Check what blocks you can connect to Roboflow Visual Search in version v1.
- inputs:
Keypoint Visualization,Stitch OCR Detections,Twilio SMS/MMS Notification,OPC UA Writer Sink,PP-OCR,Qwen 3.6 API,Blur Visualization,EasyOCR,SIFT Comparison,Anthropic Claude,Grid Visualization,CSV Formatter,Color Visualization,Llama 3.2 Vision,PLC Writer,Image Convert Grayscale,Absolute Static Crop,Stitch OCR Detections,Distance Measurement,Roboflow Visual Search Classifier,Single-Label Classification Model,Qwen 3.5 API,Image Threshold,Icon Visualization,Polygon Zone Visualization,Trace Visualization,Current Time,CogVLM,Model Comparison Visualization,Camera Focus,QR Code Generator,Google Gemini,Image Stack,MQTT Writer,Contrast Equalization,Google Gemini,OCR Model,GLM-OCR,Qwen-VL,Background Subtraction,Mask Visualization,Reference Path Visualization,Contrast Enhancement,Twilio SMS Notification,Instance Segmentation Model,Google Gemma API,MoonshotAI Kimi,Microsoft SQL Server Sink,Text Display,VLM As Detector,Florence-2 Model,Dynamic Crop,Halo Visualization,Image Blur,Stability AI Image Generation,LMM,Google Vision OCR,Webhook Sink,OpenAI,Ellipse Visualization,Pixelate Visualization,Stitch Images,OpenAI,Florence-2 Model,Line Counter,LMM For Classification,S3 Sink,Classification Label Visualization,MoonshotAI Kimi,Polygon Visualization,Anthropic Claude,Roboflow Dataset Upload,Event Writer,OpenAI,Keypoint Detection Model,Morphological Transformation,Google Gemma,Detection Event Log,Bounding Box Visualization,Template Matching,Slack Notification,Image Contours,Image Slicer,Heatmap Visualization,Stability AI Outpainting,Anthropic Claude,Email Notification,Circle Visualization,Roboflow Custom Metadata,Perspective Correction,Camera Focus,Camera Calibration,Roboflow Asset Library Attributes,Crop Visualization,Morphological Transformation,Polygon Visualization,Line Counter,Multi-Label Classification Model,Relative Static Crop,Background Color Visualization,Model Monitoring Inference Aggregator,Stability AI Inpainting,Clip Comparison,OpenAI-Compatible LLM,Corner Visualization,Object Detection Model,SIFT,VLM As Classifier,Image Slicer,Google Gemini,Roboflow Vision Events,Roboflow Visual Search,OpenRouter,Llama 3.2 Vision,Qwen3.5-VL,Local File Sink,Email Notification,Triangle Visualization,OpenAI,Roboflow Dataset Upload,Pixel Color Count,Dot Visualization,Image Preprocessing,SIFT Comparison,Line Counter Visualization,Halo Visualization,Depth Estimation,Label Visualization - outputs:
Perception Encoder Embedding Model,Qwen 3.6 API,Object Detection Model,PLC Writer,Llama 3.2 Vision,Distance Measurement,Roboflow Visual Search Classifier,Polygon Zone Visualization,BoT-SORT Tracker,Contrast Equalization,Google Gemini,Background Subtraction,Twilio SMS Notification,VLM As Detector,Florence-2 Model,Halo Visualization,SAM 3 Interactive,Dynamic Crop,Seg Preview,Ellipse Visualization,Florence-2 Model,Line Counter,Cache Set,OpenAI,Time in Zone,Google Gemma,Buffer,Semantic Segmentation Model,Email Notification,Detections Consensus,Crop Visualization,Polygon Visualization,Keypoint Detection Model,Line Counter,Object Detection Model,VLM As Classifier,Google Gemini,Multi-Label Classification Model,Qwen3.5,Object Detection Model,Time in Zone,Instance Segmentation Model,PP-OCR,Blur Visualization,Clip Comparison,EasyOCR,PLC EthernetIP,Segment Anything 2 Model,Color Visualization,Dynamic Zone,Motion Detection,Image Convert Grayscale,Stitch OCR Detections,Qwen 3.5 API,Trace Visualization,Current Time,Cache Get,PLC Reader,QR Code Generator,Google Gemini,Detections Stitch,Image Stack,Instance Segmentation Model,MoonshotAI Kimi,Microsoft SQL Server Sink,Webhook Sink,Pixelate Visualization,Stitch Images,Polygon Visualization,Morphological Transformation,SmolVLM2,Template Matching,Image Slicer,Barcode Detection,Roboflow Asset Library Attributes,Relative Static Crop,Model Monitoring Inference Aggregator,Clip Comparison,SIFT,Dominant Color,Moondream2,OpenRouter,Qwen3.5-VL,Email Notification,Triangle Visualization,Roboflow Dataset Upload,Pixel Color Count,SIFT Comparison,Keypoint Visualization,Twilio SMS/MMS Notification,Keypoint Detection Model,OPC UA Writer Sink,Grid Visualization,SAM 3,Absolute Static Crop,Image Threshold,CogVLM,MQTT Writer,Detections List Roll-Up,GLM-OCR,OCR Model,Contrast Enhancement,Reference Path Visualization,Google Gemma API,Instance Segmentation Model,Mask Edge Snap,PTZ Tracking (ONVIF),Detections Classes Replacement,Image Blur,LMM,SAM 3,OpenAI,LMM For Classification,Time in Zone,Path Deviation,Instance Segmentation Model,Event Writer,Semantic Segmentation Model,Single-Label Classification Model,Keypoint Detection Model,Slack Notification,Heatmap Visualization,SORT Tracker,Circle Visualization,Perspective Correction,Camera Focus,Byte Tracker,ByteTrack Tracker,Multi-Label Classification Model,Stability AI Inpainting,OpenAI-Compatible LLM,SAM 3,Image Slicer,Roboflow Vision Events,Size Measurement,Local File Sink,SAM3 Video Tracker,Dot Visualization,QR Code Detection,Line Counter Visualization,Depth Estimation,Stitch OCR Detections,Anthropic Claude,Per-Class Confidence Filter,Qwen2.5-VL,Qwen3-VL,Single-Label Classification Model,Icon Visualization,Model Comparison Visualization,Camera Focus,Qwen-VL,Mask Visualization,Text Display,Gaze Detection,Stability AI Image Generation,Google Vision OCR,OpenAI,VLM As Detector,S3 Sink,Classification Label Visualization,MoonshotAI Kimi,Anthropic Claude,Roboflow Dataset Upload,Bounding Box Visualization,VLM As Classifier,Image Contours,Stability AI Outpainting,Anthropic Claude,Roboflow Custom Metadata,Multi-Label Classification Model,SAM2 Video Tracker,Camera Calibration,Morphological Transformation,Detections Stabilizer,Path Deviation,Background Color Visualization,Corner Visualization,GeoTag Detection,Track Class Lock,Roboflow Visual Search,Llama 3.2 Vision,CLIP Embedding Model,Single-Label Classification Model,OpenAI,OC-SORT Tracker,Image Preprocessing,YOLO-World Model,Halo Visualization,Label Visualization
Input and Output Bindings¶
The available connections depend on its binding kinds. Check what binding kinds
Roboflow Visual Search in version v1 has.
Bindings
-
input
image(image): Image to use as the visual search query..workspace(string): Roboflow workspace URL slug that owns the target project..target_project(roboflow_project): Roboflow project URL slug to search..top_k(integer): Number of visually similar image candidates to return. Use 1 when you only need the nearest candidate..
-
output
candidate_found(boolean): Boolean flag.best_candidate(dictionary): Dictionary.candidates(list_of_values): List of values of any type.error_status(boolean): Boolean flag.message(string): String value.best_candidate_image(image): Image in workflows.best_candidate_metadata(dictionary): Dictionary.best_candidate_tags(list_of_values): List of values of any type.
Example JSON definition of step Roboflow Visual Search in version v1
{
"name": "<your_step_name_here>",
"type": "roboflow_core/visual_search@v1",
"image": "$inputs.image",
"workspace": "my-workspace",
"target_project": "reference-images",
"top_k": 1
}