API Documentation

Your guide to integrating with the CopySight API.

Base URL

All API requests should be made to the following base URL:

https://api.copysight.ai/v1

Endpoints

POST/verify

Analyzes an image to detect intellectual property and returns a list of findings.

Headers

Key	Description
X-API-Key	Your unique API key for authentication.

Request Body

The request should be a multipart/form-data payload containing the image file to be analyzed.

Successful Response (200 OK)

A JSON object with a success flag and a result object containing a contains_face boolean and a detected_ips array of detected intellectual property objects.

{
  "success": true,
  "result": {
    "contains_face": false,
    "detected_ips": [
      {
        "name": "Mickey Mouse",
        "category": "Characters",
        "author": "Walt Disney and Ub Iwerks",
        "owner": "The Walt Disney Company",
        "bounding_box": {
          "x": 0.277,
          "y": 0.469,
          "width": 0.021,
          "height": 0.022
        },
        "similarity": 0.98
      }
    ]
  }
}

Response Object Schema

Field	Type	Description
success	Boolean	Indicates whether the request was processed successfully.
result.contains_face	Boolean	Whether the image contains a human face.
result.detected_ips	Array	List of detected intellectual property objects. Each item contains the fields below.
category	String	Category of the IP. Can be 'Trademarks', 'Brand and iconic designs', 'Characters', 'Celebrities and famous people', 'Art and artists'.
name	String	Name of the intellectual property.
author	String	Original creator of the intellectual property.
owner	String	Current owner or rights holder of the intellectual property.
bounding_box	Object	Normalized coordinates and dimensions of the detected IP (values from 0 to 1): {"x": number, "y": number, "width": number, "height": number}
similarity	Number	The confidence/similarity score of the detection (0-1).

Error Responses

When an error occurs, the API returns an appropriate HTTP status code along with a JSON error response.

401Unauthorized

Invalid or missing API key. Ensure your X-API-Key header is correct.

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

400Bad Request

Invalid file format or corrupted file. Only image files+gif's are supported for now. BETA Support for videos is comming.

{
  "error": "Bad Request",
  "message": "Unsupported file format or corrupted file"
}

429Too Many Requests

Rate limit exceeded. Please wait before making another request.

{
  "error": "Too Many Requests",
  "message": "Rate limit exceeded. Try again later.",
  "retry_after": 60
}