Object Detection

POST 
/api/v5/detect/yolo

Use YOLO model for object detection in images, identify objects in the images

Request

Header Parameters

Authorization stringrequired

User Personal Token

application/json

Body

modelstringrequired
Model weight file names for yolo11 (yolo11n.pt, yolo11s.pt, yolo11m.pt, yolo11l.pt, yolo11x.pt)
Example: yolo11n.pt
sourcestringrequired
Base64 encoded string of the image to be detected
Example: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQXXXXXXX
imgszintegerrequired
The size of the input image, the valid range is 32-1280 pixels.
Possible values: >= 32 and <= 1280
Example: 640
confnumberrequired
Predicted confidence threshold, valid range 0.01 - 1.0
Possible values: >= 0.01 and <= 1
Example: 0.5
iounumberrequired
IoU threshold, valid range 0.0 - 0.95
Possible values: <= 0.95
Example: 0.45

Responses

200

Response Headers

application/json

Schema

Schema

images object[]required
List of detection result images
Array [
results object[]required
Test Result List
Array [
box objectrequired
Bounding Box Coordinates
x1numberrequired
Top-left x coordinate
Example: 14.55554
x2numberrequired
Lower right x coordinate
Example: 72.45978
y1numberrequired
Top-left y coordinate
Example: 116.72369
y2numberrequired
Lower right y-coordinate
Example: 268.92963
classinteger
Category ID
Example: 0
confidencenumberrequired
Confidence Level
Example: 0.83583
namestringrequired
Category Name
Example: person
]
shapeinteger[]required
Image size [width, height]
speed objectrequired
Processing speed information
inferencenumberrequired
Inference Time (ms)
Example: 56.13449
postprocessnumberrequired
Post-processing Time (ms)
Example: 0.05426
preprocessnumberrequired
Preprocessing Time (ms)
Example: 21.20275
]
metadata objectrequired
Metadata Information
functionTimeAlivenumber
Function Survival Time (ms)
Example: 163779.863
functionTimeCallnumber
Function call time (ms)
Example: 0.57
imageCountinteger
Number of images
Example: 1
modelstring
Model Name
Example: yolo11n-cls.pt
version objectrequired
Version Information
pythonstringrequired
Python version
Example: 3.11.14
torchstring
PyTorch Version
Example: 2.9.1+cpu
torchvisionstring
版本
Example: 0.24.1+cpu
ultralyticsstringrequired
ultralytics version
Example: 8.3.228

Example (auto)

{
  "images": [
    {
      "results": [
        {
          "box": {
            "x1": 14.55554,
            "x2": 72.45978,
            "y1": 116.72369,
            "y2": 268.92963
          },
          "class": 0,
          "confidence": 0.83583,
          "name": "person"
        }
      ],
      "shape": [
        0
      ],
      "speed": {
        "inference": 56.13449,
        "postprocess": 0.05426,
        "preprocess": 21.20275
      }
    }
  ],
  "metadata": {
    "functionTimeAlive": 163779.863,
    "functionTimeCall": 0.57,
    "imageCount": 1,
    "model": "yolo11n-cls.pt",
    "version": {
      "python": "3.11.14",
      "torch": "2.9.1+cpu",
      "torchvision": "0.24.1+cpu",
      "ultralytics": "8.3.228"
    }
  }
}

Example

{
  "images": [
    {
      "results": [
        {
          "box": {
            "x1": 1.511962890625,
            "x2": 263.31793212890625,
            "y1": 0.378143310546875,
            "y2": 200.42999267578125
          },
          "confidence": 0.6070891618728638,
          "name": "person"
        }
      ],
      "shape": [
        203,
        320
      ],
      "speed": {
        "inference": 235.26057600975037,
        "postprocess": 1.4520995318889618,
        "preprocess": 3.9573051035404205
      }
    }
  ],
  "metadata": {
    "version": {
      "python": "3.11.13",
      "ultralytics": "8.3.231"
    }
  }
}