Reporting

Your feedback is extremely valuable to us, so please don't hesitate to share your thoughts!

This API endpoint allows you to report and review images. To report an image, you must provide the image_id , score, categories, and a valid API key.

Before you continue You can find the list of report categories in the API specification. Additionally, there's an optional comment property where you can provide any feedback.

JavaScript

const imageId = "ID_OF_YOUR_IMAGE";
const apiKey = "YOUR_API_KEY";
const score = 4;
const categories = ["LENS_CORRECTION","AUTO_PRIVACY"]

const reportImage = async (imageId, apiKey, score, categories) => {
    const reportImageResponse = await fetch(
      `https://api.autoenhance.ai/v3/images/${imageId}/report`,
      { 
        method: "POST" 
        headers:{
          "x-api-key": apiKey,  
        },
        body: JSON.stringify({
          score: score,
          categories: categories
        }),
      }
    );
}

Python

import requests
import json

image_id = "ID_OF_YOUR_IMAGE"
api_key = "YOUR_API_KEY"
score = 4
categories = ["LENS_CORRECTION", "AUTO_PRIVACY"]

def report_image(image_id, api_key, score, categories):
    url = f"https://api.autoenhance.ai/v3/images/{image_id}/report"
    headers = {
        "x-api-key": api_key,
        "Content-Type": "application/json"
    }
    data = {
        "score": score,
        "categories": categories
    }

    response = requests.post(url, headers=headers, data=json.dumps(data))
    return response

PHP

$image_id = "ID_OF_YOUR_IMAGE";
$api_key = "YOUR_API_KEY";
$score = 4;
$categories = array("LENS_CORRECTION", "AUTO_PRIVACY");

function report_image($image_id, $api_key, $score, $categories) {
    $url = "https://api.autoenhance.ai/v3/images/$image_id/report";

    $data = array(
        'score' => $score,
        'categories' => $categories
    );

    $options = array(
        'http' => array(
            'header'  => "Content-Type: application/json\r\n" .
                         "x-api-key: $api_key",
            'method'  => 'POST',
            'content' => json_encode($data),
        ),
    );

    $context  = stream_context_create($options);
    $result = file_get_contents($url, false, $context);

    if ($result === FALSE) {
        return 'Error reporting image';
    }

    return 'Image reported successfully';
}

cURL

curl -X POST \
  https://api.autoenhance.ai/v3/images/ID_OF_YOUR_IMAGE/report \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
        "score": 4,
        "categories": ["LENS_CORRECTION", "AUTO_PRIVACY"]
    }'

Specification

Report Image

post

Authorizations

Path parameters

idstringrequired

Body

categoriesstring · enum[]required

A list of categories to be reported.

commentstringoptional

A comment to be sent along with the report.

scoreinteger · max: 5optional

A rating between 0 and 5 on how good the image enhancmeent. Higher is better.

sourcestring · enumoptional

Available options:

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.autoenhance.ai/v3/images/{id}/report' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "categories": [
      "AUTO_PRIVACY"
    ],
    "comment": "text",
    "score": 1,
    "source": "WEBAPP"
  }'

200

401

404

422

200

No body

Successful response