Deepfaic Edge
Deepfaic Edge is the single-machine, offline runtime of the Deepfaic platform. It runs entirely inside your own cloud as a managed docker-compose stack - the API, Metadata, Cache, and the detection inference.
This section covers everything you need after installation: the endpoints to call, how to authenticate, the CONFIG.yaml reference, and how to apply configuration changes.
These pages assume the edge stack is already running on your host. If you still need to install the runtime, that flow is handled by the deepfaic-installer bootstrap and is provided separately by your Deepfaic administrator.
Base URL
The edge API is published on the host at the port configured by api_port in CONFIG.yaml (default 9123). All endpoints are versioned under /v1:
http://<edge-host>:9123/v1
Response envelope
Every endpoint returns the same JSON envelope:
{
"status": true,
"code": 200,
"message": "Description",
"data": { }
}
| Field | Type | Description |
|---|---|---|
status | boolean | true on success, false on error. |
code | number | HTTP status code, mirrored into the body. |
message | string | Human-readable result or error message. |
data | object | array | null | The endpoint payload, or null on error. |
Common error codes:
| Code | Meaning |
|---|---|
401 | Authentication failed (missing/invalid key, or token org mismatch). |
404 | The requested job does not exist. |
422 | The request body or query failed validation. |
500 | Internal error (database, I/O, or processing failure). |
Endpoints
Service
| Endpoint | Description | Link |
|---|---|---|
| Health | Authenticated health check with org and token metadata | View Details |
Jobs
| Endpoint | Description | Link |
|---|---|---|
| Create Job | Queue a deepfake analysis job for a file on the host | View Details |
| List Jobs | List full job records with filters, sorting, and paging | View Details |
| List Jobs (Partial) | List jobs with a reduced payload | View Details |
| Get Job | Retrieve a single full job record with scores | View Details |
| Get Job (Partial) | Retrieve a single job with a reduced payload | View Details |
| Delete Job | Soft-delete a completed or failed job | View Details |
| Hard Delete Job | Permanently remove a job's files, data, or both | View Details |
Scoring Profiles
| Endpoint | Description | Link |
|---|---|---|
| Import Profile | Install a signed scoring-profile bundle from Deepfaic | View Details |
| List Profiles | List installed scoring profiles | View Details |
| Remove Profile | Stop new jobs from selecting a profile | View Details |
Operating the runtime
| Topic | Link |
|---|---|
| Authenticating requests | Authentication |
The CONFIG.yaml reference | Configuration |