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

Specification

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
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

Last updated