LogoAI ForensiX

API Reference

AI-Forensix – API Reference

This section explains how developers can interact with AI-Forensix Deepfake Detection API, including how to create analysis tasks, submit media, and retrieve results.


Authentication

All API calls require the following header:

x-api-key: YOUR_API_KEY 

The API Key is generated in your Haranzel Dashboard after selecting your service scopes.


1. Create an Analysis Task

Each detection service is triggered using its own dedicated endpoint.

All tasks return immediately with a task_id, while processing happens asynchronously.

Example Response

{
  "task_id": "abc12345",
  "success": true,
  "message": "Task accepted. Processing started."
}

2. Retrieve Task Results (Polling Only)

AI-Forensix uses simple polling to retrieve detection results.

Endpoint

GET /tasks/{task_id}

Example

curl -X GET "https://forensiz.ai/abc" 
-H "x-api-key: YOUR_API_KEY"

Response States

Completed

{
"task_id": "abc12345",
"status": "completed",
"summary": {
"verdict": "fake",
"score": 0.92
}
}

In Progress

{
"task_id": "abc12345",
"status": "in_progress"
}

Failed

{
"task_id": "abc12345",
"status": "failed",
"error": "Model timeout"
}

On this page