Skip to main content

Job Get Partial

  • Retrieves essential information about jobs with reduced data payload. It's optimized for faster responses and lower bandwidth usage, returning only key fields without detailed frame analysis data.
GET /v1/job/get/partial

Auth and Rate Limits​

  • Authentication is required for this endpoint. You must include a valid API key in the Authorization header.
  • This API call is rate limited to 100 requests per minute.

Query Parameters​

  • All parameters are optional and can be used to filter and sort the results.
ParameterTypeDescriptionRequired
job_idintegerFilter by specific job IDNo
file_idstringFilter by file ID (UUID)No
statusstringFilter by job status (e.g., "completed", "submitted")No
modelstringFilter by model type ("facia", "diffusion", "swintf", "audio")No
order_bystringSort direction ("asc", "desc"). Legacy alias for sort_orderNo
limitintegerLimit number of resultsNo
offsetintegerPagination offset (use with limit)No
sort_bystringSort field: "date", "created_at", "id", "status", "title", "file_type"No
sort_orderstringSort direction: "asc" or "desc" (default: "desc")No
user_idstringFilter by user ID (for multi-user org queries)No
scopestring"mine" (default) returns only your own jobs; "org" returns every job in your organization. See Organization-wide access.No

Organization-wide access​

By default this endpoint returns only the jobs created by the API key's own user. Pass scope=org to list every job in your organization instead.

  • scope=org requires an admin or sub-admin role in that organization; any other role is rejected with 403.
  • An unrecognised value is rejected with 422.
  • The organization is taken from your API key — there is nothing extra to send.
curl "https://api.deepfaic.com/v1/job/get/partial?scope=org&limit=50" \
-H "Authorization: Bearer <api_key>"

Response​

{
"status": true,
"code": 200,
"message": "Partial jobs data fetched successfully",
"data": [
{
"audio": {
"chunk_scores": [
0.6623894858078649,
0.803149147442714
],
"coverage": 1.0,
"error": null,
"score": 0.8425193179541712,
"status": "complete",
"threshold": 0.4
},
"job": {
"created_at": "2026-01-01T02:27:19.732Z",
"file_name": "0021.mp4",
"file_type": "video",
"id": 2879,
"length": "00:00:06",
"progress": 100.0,
"status": "complete",
"stream_state": null,
"title": "0021.mp4"
},
"video": {
"chunk_scores": [
0.724148335250119,
0.7211285001478722
],
"coverage": 1.0,
"error": null,
"score": 0.7793186682000952,
"status": "complete",
"threshold": 0.4
}
}
]
}```

---

### Example Requests

```bash
curl "https://api.deepfaic.com/v1/job/get/partial" \
-H "Authorization: Bearer <api_key>"

Additional Response Fields​

Per-model results — Each job includes a models object with the score and status for each model:

"models": {
"facia": { "score": 0.95, "status": "complete", "error": null },
"diffusion": { "score": 0.87, "status": "complete", "error": null },
"swintf": { "score": 0.91, "status": "complete", "error": null },
"audio": { "score": 0.72, "status": "complete", "error": null },
"dfaudio": { "score": null, "status": null, "error": null },
"object": { "score": null, "status": null, "error": null }
}

Status info:

"statusInfo": {
"status": "completed",
"statusText": "Detection Complete",
"isComplete": true,
"hasError": false,
"isInProgress": false
}