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:
Image Slicer,Polygon Zone Visualization,VLM As Classifier,Line Counter,Contrast Enhancement,Google Gemma API,MoonshotAI Kimi,Stability AI Image Generation,Image Threshold,Line Counter Visualization,Trace Visualization,Stitch OCR Detections,Distance Measurement,Image Stack,Camera Calibration,QR Code Generator,Anthropic Claude,Detection Event Log,Icon Visualization,SIFT Comparison,Morphological Transformation,S3 Sink,Color Visualization,LMM For Classification,Perspective Correction,Microsoft SQL Server Sink,Corner Visualization,Roboflow Custom Metadata,Google Vision OCR,Twilio SMS Notification,Halo Visualization,Image Blur,Morphological Transformation,Qwen-VL,Camera Focus,Email Notification,Roboflow Vision Events,Halo Visualization,Stability AI Inpainting,Classification Label Visualization,Stitch OCR Detections,Google Gemma,Event Writer,Grid Visualization,Qwen3.5-VL,Background Color Visualization,Mask Visualization,Llama 3.2 Vision,Ellipse Visualization,Email Notification,Reference Path Visualization,Image Slicer,Label Visualization,Twilio SMS/MMS Notification,Text Display,SIFT Comparison,OPC UA Writer Sink,Dot Visualization,Polygon Visualization,Crop Visualization,Dynamic Crop,Absolute Static Crop,Circle Visualization,Image Preprocessing,Llama 3.2 Vision,Model Monitoring Inference Aggregator,Relative Static Crop,Camera Focus,OpenRouter,OpenAI,Template Matching,Florence-2 Model,OpenAI-Compatible LLM,MoonshotAI Kimi,Heatmap Visualization,Single-Label Classification Model,OpenAI,OCR Model,CogVLM,Blur Visualization,Depth Estimation,Instance Segmentation Model,Stability AI Outpainting,Anthropic Claude,Google Gemini,Qwen 3.6 API,Clip Comparison,Google Gemini,Background Subtraction,Keypoint Visualization,CSV Formatter,Webhook Sink,Bounding Box Visualization,Multi-Label Classification Model,LMM,OpenAI,Stitch Images,Florence-2 Model,Image Convert Grayscale,Current Time,Contrast Equalization,OpenAI,VLM As Detector,Line Counter,Google Gemini,Roboflow Visual Search,Triangle Visualization,Slack Notification,EasyOCR,Roboflow Dataset Upload,Pixelate Visualization,Roboflow Dataset Upload,PLC Writer,SIFT,Qwen 3.5 API,Anthropic Claude,Object Detection Model,Local File Sink,MQTT Writer,Image Contours,Polygon Visualization,Keypoint Detection Model,Pixel Color Count,GLM-OCR,Model Comparison Visualization,Roboflow Asset Library Attributes - outputs:
VLM As Classifier,Line Counter,MoonshotAI Kimi,Stability AI Image Generation,Trace Visualization,Path Deviation,Qwen2.5-VL,Image Stack,Anthropic Claude,Per-Class Confidence Filter,Icon Visualization,SIFT Comparison,Morphological Transformation,Color Visualization,SmolVLM2,LMM For Classification,Single-Label Classification Model,Perspective Correction,Corner Visualization,Clip Comparison,Roboflow Custom Metadata,Halo Visualization,Dynamic Zone,Keypoint Detection Model,Qwen-VL,Email Notification,Halo Visualization,Object Detection Model,Google Gemma,Background Color Visualization,Ellipse Visualization,Email Notification,Twilio SMS/MMS Notification,Text Display,Polygon Visualization,Crop Visualization,Absolute Static Crop,Image Preprocessing,Template Matching,Model Monitoring Inference Aggregator,Relative Static Crop,OpenRouter,OpenAI,VLM As Detector,Florence-2 Model,Motion Detection,Heatmap Visualization,OpenAI,OCR Model,Perception Encoder Embedding Model,Blur Visualization,Barcode Detection,Depth Estimation,Instance Segmentation Model,Stability AI Outpainting,Anthropic Claude,YOLO-World Model,Google Gemini,Clip Comparison,Google Gemini,PLC EthernetIP,Background Subtraction,Keypoint Visualization,Buffer,Webhook Sink,Stitch Images,Florence-2 Model,Current Time,Detections List Roll-Up,Contrast Equalization,Mask Edge Snap,OpenAI,Qwen3-VL,Moondream2,Line Counter,VLM As Detector,Google Gemini,Slack Notification,Triangle Visualization,Time in Zone,CLIP Embedding Model,Detections Stabilizer,SIFT,Multi-Label Classification Model,Local File Sink,Keypoint Detection Model,VLM As Classifier,Image Contours,Pixel Color Count,GLM-OCR,Roboflow Asset Library Attributes,Polygon Zone Visualization,Image Slicer,Time in Zone,Google Gemma API,Contrast Enhancement,Stitch OCR Detections,Line Counter Visualization,Semantic Segmentation Model,Distance Measurement,Image Threshold,Multi-Label Classification Model,Semantic Segmentation Model,Camera Calibration,QR Code Generator,ByteTrack Tracker,S3 Sink,Microsoft SQL Server Sink,Twilio SMS Notification,Google Vision OCR,Image Blur,Morphological Transformation,Camera Focus,Roboflow Vision Events,Size Measurement,PTZ Tracking (ONVIF),Stability AI Inpainting,Classification Label Visualization,Stitch OCR Detections,SAM2 Video Tracker,Event Writer,Grid Visualization,Qwen3.5-VL,Mask Visualization,Llama 3.2 Vision,Dominant Color,Reference Path Visualization,Image Slicer,Label Visualization,Byte Tracker,OPC UA Writer Sink,Dot Visualization,Cache Set,Path Deviation,Dynamic Crop,Circle Visualization,Llama 3.2 Vision,BoT-SORT Tracker,SAM3 Video Tracker,Detections Stitch,Camera Focus,Gaze Detection,Segment Anything 2 Model,MoonshotAI Kimi,OpenAI-Compatible LLM,Single-Label Classification Model,QR Code Detection,Qwen3.5,CogVLM,Object Detection Model,SAM 3 Interactive,Qwen 3.6 API,Detections Consensus,Bounding Box Visualization,Multi-Label Classification Model,LMM,SAM 3,OpenAI,PLC Reader,Image Convert Grayscale,Instance Segmentation Model,Roboflow Visual Search,EasyOCR,Roboflow Dataset Upload,SAM 3,Cache Get,Instance Segmentation Model,Detections Classes Replacement,Pixelate Visualization,Keypoint Detection Model,Instance Segmentation Model,Roboflow Dataset Upload,PLC Writer,SORT Tracker,Track Class Lock,Qwen 3.5 API,Object Detection Model,Anthropic Claude,Time in Zone,MQTT Writer,Polygon Visualization,OC-SORT Tracker,SAM 3,Model Comparison Visualization,Single-Label Classification Model,Seg Preview
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
}