Skip to main content

Create Job

Queue a deepfake analysis job for a media file that is already present on the edge host. Processing runs in the background; the response returns immediately with the new job id.

POST /v1/jobs

Authentication​

  • Authentication is required. Include a valid df_ API key in the Authorization header, or rely on the machine-local default credential. See Authentication.

Request Body​

The body is a JSON object. Edge jobs reference a file by path.

ParameterTypeDescriptionRequired
input_pathstringPath to the media file as seen inside the edge API container (e.g. /var/lib/deepfaic/uploads/sample.mp4). The file must exist and be visible to the container.Yes
titlestringA descriptive label for the job (1–255 characters).No
profile_namestringAn installed scoring profile to score this job with — "name" for the latest installed version or "name@version" to pin one. The profile is frozen onto the job at creation. Omit to score with the CONFIG.yaml defaults.No
{
"input_path": "/var/lib/deepfaic/uploads/sample.mp4",
"title": "Q3 onboarding call",
"profile_name": "clip-jury"
}

Response​

The job is created in the queued state and begins processing in the background.

{
"status": true,
"code": 200,
"message": "Job created",
"data": {
"job_id": 42,
"status": "queued"
}
}

Poll Get Job (or Get Job (Partial)) with the returned job_id to track progress and retrieve scores.


Errors​

CodeCondition
422input_path is missing/blank, the file is not visible inside the container, the file type is unsupported, title is blank or over 255 chars, or profile_name does not match any installed active profile

Example Request​

curl -X POST http://<edge-host>:9123/v1/jobs \
-H "Authorization: Bearer df_..." \
-H "Content-Type: application/json" \
-d '{"input_path": "/var/lib/deepfaic/uploads/sample.mp4"}'