Sign in

v1

latestOpenAPI 3.0.12026-07-14453659.5 KB
Vision Prediction

Detection with Image File

Returns labels, probabilities, and bounding box coordinates for items detected in the specified local image file.

post/v2/vision/detect

Request body

modelIdstring required

ID of the model that makes the detection.

sampleBase64Contentstring

The image contained in a base64 string.

sampleIdstring

String that you can pass in to tag the prediction. Optional. Can be any value, and is returned in the response.

sampleLocationstring

URL of the image file.

Example request

{
  "modelId": "YCQ4ZACEPJFGXZNRA6ERF3GL5E",
  "sampleBase64Content": "SomeBase64EncodedImage"
}

Response

Detection Result

objectstring
sampleIdstring

Value passed in when the prediction call was made. Returned only if the sampleId request parameter is provided.

Example response

{
  "object": "predictresponse",
  "sampleId": "Sample1"
}