Object Detection Response

The Copyleaks Object Detection API returns the dimensions of the analyzed image and, for each requested object that was found, a Run-Length Encoded (RLE) segmentation mask. Objects that were requested but not found in the image are omitted from detectedObjects, so the array is not aligned by position with the request - look entries up by object.

Response Properties

imageInfo

object

Information about the analyzed image.

Show properties

shape

object

The dimensions of the image, used to decode the RLE masks.

Show properties

height

integer

The height of the image in pixels.

width

integer

The width of the image in pixels.

detectedObjects

array<object>

One entry per object located in the image. Objects that were requested but not found are absent.

Show properties

object

string

The object description from the request that this entry corresponds to.

mask

object

The Run-Length Encoded (RLE) segmentation mask for this object.

Show properties

starts

array<integer>

An array of starting positions for each segment in the flattened 1D image array.

lengths

array<integer>

An array of lengths for each segment, corresponding to the starts array.

scannedImage

object

Metadata about the scan operation itself.

Show properties

scanId

string

The unique identifier for this scan, provided by you in the request.

credits

integer

The actual number of credits consumed by the scan.

expectedCredits

integer

The expected number of credits for the scan.

creationTime

string

The ISO 8601 timestamp indicating when the scan was created.

Example Response

{
  "imageInfo": {
    "shape": {
      "height": 1024,
      "width": 768
    }
  },
  "detectedObjects": [
    {
      "object": "face",
      "mask": {
        "starts": [200, 412],
        "lengths": [50, 30]
      }
    }
  ],
  "scannedImage": {
    "scanId": "my-scan-id-1",
    "credits": 1,
    "expectedCredits": 1,
    "creationTime": "2023-01-10T10:07:58.9459512Z"
  }
}

Next Steps

Object Detection API Reference

Explore the complete API reference for the Object Detection endpoint.

AI Image Detection

Detect whether an image is AI-generated.

AI Video Detection Response Overview

Reference

Actions

Data Types

Response Properties

Example Response

Next Steps

Object Detection API Reference

AI Image Detection

​Response Properties

​Example Response

​Next Steps

Object Detection API Reference

AI Image Detection

Response Properties

Example Response

Next Steps