Skip to main content

process_image

Process one base64-encoded image.

  • Method: POST
  • Path: /process_image

Request Body

{
"file": "<base64 image>",
"return_image": true,
"regions": [],
"effects": {}
}
FieldTypeDescription
filestringBase64-encoded image payload.
return_imagebooleanWhen true, the response can include an annotated image.
regionsRegion[]Detection regions to evaluate.
effectsEffectsOptional overlay settings for returned imagery.

Success Response

{
"success": true,
"message": null,
"data": {
"detections": [],
"image": "<base64 image>"
}
}
FieldTypeDescription
data.detectionsDetection[]Detection results for the supplied image.
data.imagestringOptional annotated image when return_image is enabled.