Autoenhance.ai
  • Overview
  • Getting Started
    • Obtaining an API key
    • Quickstart
      • Single Image
      • HDR Brackets
    • Code Examples
      • JavaScript
        • Uploading Single Bracket
        • Uploading HDR
        • Uploading 360
      • API Integrations Repository
  • SDKs
    • Web (Beta)
      • Changelog
    • JavaScript
      • Changelog
    • Python
      • Changelog
  • File & Camera Guidelines
    • File Formats
    • Metadata
    • 360
    • Lens Correction
  • Images
    • Managing Images
      • Creating & Uploading
      • Reprocessing
      • Retrieveing
      • Deleting
      • Reporting
    • Settings
      • Enhancement Style
      • Sky Replacement
      • Lens Correction
      • Vertical Correction
      • Window Pull
      • Auto Privacy
      • Usage Example
    • Downloading Images
      • Original
      • Preview
      • Enhanced
  • Orders
    • Managing Orders
      • Creating
      • Editing
      • Retrieving
      • Listing and Pagination
      • Deleting
    • Grouping Brackets and Processing Orders
  • Webhooks
  • API Versions
  • AI Versions
  • Links
    • API Specification
    • Support
Powered by GitBook
On this page
  1. Images
  2. Managing Images

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.

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
        }),
      }
    );
}
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
$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 -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

PreviousDeletingNextSettings

Last updated 11 months ago

  • Specification
  • POSTReport Image

Report Image

post
Authorizations
Path parameters
idstringRequired
Body
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 · enumOptionalPossible values:
Responses
200
Successful response
application/json
Responseany
401
Authentication error
application/json
404
Not found
application/json
422
Validation error
application/json
post
POST /v3/images/{id}/report HTTP/1.1
Host: api.autoenhance.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "categories": [
    "AUTO_PRIVACY"
  ],
  "comment": "text",
  "score": 1,
  "source": "WEBAPP"
}

No content