POST
Detect whether an image is AI-generated or partially AI-generated. Returns a detailed analysis with an RLE mask indicating AI-generated regions. Optionally, pass objectDetection to also locate specific objects in the image (for example a face or a hand) and receive a segmentation mask for each one in the same response.
AI Image Detection has wrapper support in the Python SDK via ImageDetectionClient. The JavaScript and Java SDKs don’t yet expose a method for this endpoint, so those samples call the HTTP API directly.
Authentication Required. You need to login with a user and API key in order to access this method. Add this HTTP header to your request:Authorization: Bearer <Your-Login-Token>
Image detection API has a rate limit of 900 requests per 15 minutes per host. If exceeded, requests will be rejected with a 429 status code until the rate limit window resets.

Request

Path Parameters

string
required
A unique scan id provided by you. We recommend you use the same id in your database to represent the scan in the Copyleaks database. This will help you to debug incidents. Using the same ID for the same file will help you to avoid network problems that may lead to multiple scans for the same file. Learn more about the criteria for creating a Scan ID.>= 3 characters <= 36 characters

Supported Content Types

Submit images using multipart/form-data (recommended) or JSON with base64.
multipart/form-data sends the image file directly without base64 encoding overhead, making it more efficient for large images. Use application/json when you need to submit image data as a base64-encoded string.
Headers:

Option 2: JSON with Base64

Headers:
The Accept-Encoding: gzip header enables response compression, reducing bandwidth usage and improving performance.

Body Parameters

The image field used depends on the content type:
  • multipart/form-data -> use the image field (binary file)
  • application/json -> use the base64 field (base64-encoded string)
file
Binary image file. Required when using multipart/form-data. Base64-encoded images are not accepted for multipart requests.Requirements:
  • Size: Minimum 512x512px, maximum 6000x4500px (27 megapixels)
  • File size: Less than 32MB
  • Formats: PNG, JPG, JPEG, BMP, WebP, HEIC/HEIF
string
Base64-encoded image data. Required when using application/json content type.Requirements:
  • Size: Minimum 512x512px, maximum 6000x4500px (27 megapixels)
  • File size: Less than 32MB (before encoding)
  • Formats: PNG, JPG, JPEG, BMP, WebP, HEIC/HEIF
string
required
The name of the image file including its extension.Requirements:
  • Allowed file extensions: .png, .jpg, .jpeg, .bmp, .webp, .heic, .heif
  • <= 255 characters
string
required
The AI detection model to use for analysis.
  • AI Image 1 Ultra: "ai-image-1-ultra"
string
default:"binary"
The type of detection mask to return alongside the detection result. Use "heatmap" when you want a pixel-level visualization of how confidently each region of the image was flagged as AI-generated, or "none" when you only need the scores.Supported values:
  • "binary" (default) - Run-Length Encoded (RLE) mask of the regions flagged as AI-generated, returned as result.starts and result.lengths.
  • "heatmap" - gradient overlay highlighting AI-generated regions with intensity proportional to confidence. Adds a labels array to result with one confidence band (0-4) per RLE run.
  • "none" - no mask. The response omits the result object; every other field is unchanged.
Any other value is rejected with 400 Bad Request.Example: "heatmap"
array
Optional. A list of objects to locate and segment within the image. When provided, the response additionally includes a detectedObjects array - one entry per object found in the image, each with its Run-Length Encoded (RLE) segmentation mask. Objects that were requested but not found are omitted, so look entries up by object rather than by position.Each entry wraps the object name in an object ({ "object": "face" }) so future per-entry fields can be added without a breaking change.
  • Maximum 3 entries.
  • Each entry’s object value must be a non-empty string of at most 32 characters.
  • Using objectDetection does not change the cost of the request.
multipart/form-data: send the list as a JSON-encoded string in a single form field, for example objectDetection=[{"object":"face"},{"object":"hand"}].application/json: send the list as a JSON array.Example: [{ "object": "face" }, { "object": "hand" }]
boolean
default:"false"
Use sandbox mode to test your integration with the Copyleaks API without consuming any credits.

Responses

200 OK - The image was successfully analyzed.
When the request includes maskType: "heatmap", result additionally carries a labels array - one confidence band (0-4) per RLE run. With maskType: "none" the result object is omitted altogether. detectedObjects is present only when the request included objectDetection. See the AI Image Detection Response reference.