Search
Search for similar images
Allows for image search and filtering by multiple search parameters
https://api.roboflow.com/:workspace/:project/search
// all fields optional unless marked required
{
// when provided, provides results sorted by semantic similarity
"like_image": string,
// when provided, provides results sorted by semantic similarity
"prompt": string,
// defaults to 0
"offset": int,
// default to 50 (max: 250)
"limit": int,
// when present, filters images that have the provided tag
"tag": string,
// when present, filters images that have the provided class name
"class_name": string,
// when present, filters images that are in the provided project
"in_dataset": string,
// when present, returns only images that are in any batch
"batch": boolean
// when present, returns only images present in the provided batch
"batch_id": string
// returns a subset of fields, defaults to all except embedding ["id", "name", "annotations", "labels", "split", "tags", "owner", "embedding"]
"fields": string[]
}
$ curl -x POST "https://api.roboflow.com/my-workspace/my-project-name/search?api_key=$ROBOFLOW_API_KEY" --data
{
"like_image": "imageId123",
"in_dataset": true,
"limit": 125,
}
{
"offset": 0,
"total": 292,
"results": [
{
"id": "image123",
"name": "humpbackwhale.jpg",
"owner": "owner123",
"annotations": {
"count": 5,
"classes": {
"whale": 1,
"fish": 4
}
},
"labels": [],
"tags": [
"cam_x13"
]
}
// ... etc.
]
}
Last modified 29d ago