process_image
Process one base64-encoded image.
- Method:
POST - Path:
/process_image
Request Body
{
"file": "<base64 image>",
"return_image": true,
"regions": [],
"effects": {}
}
| Field | Type | Description |
|---|---|---|
file | string | Base64-encoded image payload. |
return_image | boolean | When true, the response can include an annotated image. |
regions | Region[] | Detection regions to evaluate. |
effects | Effects | Optional overlay settings for returned imagery. |
Success Response
{
"success": true,
"message": null,
"data": {
"detections": [],
"image": "<base64 image>"
}
}
| Field | Type | Description |
|---|---|---|
data.detections | Detection[] | Detection results for the supplied image. |
data.image | string | Optional annotated image when return_image is enabled. |