CN8 API Documentation

Detect and blur faces and license plates in video files, frame by frame. Async — poll GET /v2/jobs/{job_id} for the result.

Detection runs on every frame of the video, locating faces (and license plates when detect_lp=true) and blurring each one. Frames are reassembled with the original audio preserved. The processed video is returned as a URL in result_data when the job completes.

Submit Blur Job

curl -X POST https://api.cn8.io/v1/proxy/studio-face-blur-video \
  -H "X-API-Key: <cn8_api_key>" \
  -H "Content-Type: application/json" \
  -d '{"videoUrl":"https://example.com/file"}'

{
  "status": "accepted",
  "job": {
    "id": "job_abc123",
    "status": "queued",
    "service": "studio-face-blur-video"
  }
}

Poll for Result

curl -X GET https://api.cn8.io/v2/jobs/{job_id} \
  -H "X-API-Key: <cn8_api_key>"

{
  "id": "job_abc123",
  "status": "completed",
  "result_data": {
    "status": "success",
    "data": {
      "url": "https://s3.../videos/face-blur/.../<id>.mp4",
      "content_type": "video/mp4",
      "duration_seconds": 42.5
    },
    "usage": {
      "units": 42.5,
      "unit_type": "second",
      "details": { "detect_faces": true, "detect_lp": false }
    }
  },
  "units_consumed": 42.5,
  "token_cost": 1.275
}

Quick Example

# Step 1: Submit blur job (faces by default)
curl -X POST https://api.cn8.io/v1/proxy/studio-face-blur-video \
  -H "X-API-Key: apk_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "videoUrl": "https://s3.../clip.mp4",
    "detect_faces": true,
    "detect_lp": true
  }'

# Step 2: Poll for result (repeat until status = completed)
curl https://api.cn8.io/v2/jobs/job_abc123 \
  -H "X-API-Key: apk_your_key"

Detection toggles