Guides

Troubleshooting

Common production issues and how to resolve them quickly.

Common Issues

SymptomLikely CauseAction
Job stays processing for too longQueue backlog or large mediaPoll with backoff and set timeout guardrails
401/invalid_api_keyWrong key or key disabledRotate key and verify environment mapping
402/insufficient_creditsAccount credits below required amountTop up credits before retry
Loss of fine detailsModel/format mismatchTry original or pro, use higher source quality, avoid aggressive compression
Flicker between framesScene complexity + unstable segmentationUse original/pro, avoid aggressive post smoothing, test on representative clips

Debug Checklist

  1. Log request body (without secrets), model, format, and response status.
  2. Log job_id and correlate with server-side usage events.
  3. Check /health and /api/pricing to verify runtime config.
  4. Validate output format capability for transparency use cases.

Escalation Data to Include

  • job_id and request timestamp
  • model, output_format, and background/composition payload
  • source video metadata (duration, resolution, codec)
  • full error response body and HTTP status

Quality Guardrails

  • Prefer representative source clips when tuning model defaults.
  • Keep input compression moderate to preserve edge details.
  • Use explicit output format policy for transparent vs non-transparent workflows.
  • Run A/B validation with the same clip set before changing defaults.

Implementation Checklist

  1. Define payload schema validation in backend before forwarding requests.
  2. Store model/output_format/background settings with each job record.
  3. Add internal quality review for difficult scenes (hair, glass, motion blur).
  4. Create runbook entries for model-specific failure cases.

Incident Report Template

{
  "incident_time": "2026-04-20T10:00:00Z",
  "job_id": "job_xxx",
  "model": "pro",
  "output_format": "webm",
  "symptom": "flicker / detail loss / timeout",
  "http_status": 500,
  "error_code": "internal_error",
  "request_id": "req_xxx",
  "source_video_meta": {
    "duration_s": 12.3,
    "resolution": "1920x1080",
    "codec": "h264"
  }
}

When to Use Troubleshooting

Troubleshooting belongs to the Guides section and covers common production issues and how to resolve them quickly.

The page is written for developers and operators who need predictable video background removal behavior in production, not just a one-off demo request.

  • Use this guide when troubleshooting decisions affect output quality, processing cost, or user-facing workflow design.
  • Test guidance on representative videos rather than only short demo clips.
  • Record the chosen model, background, output format, and quality notes with each processed job for later debugging.

Implementation Notes

Before you promote this workflow, test it with at least one short clip, one longer clip, and one visually difficult clip from your actual product or customer segment.

For support and debugging, persist the original input reference, selected model, output format, credit usage, and final job status alongside your internal user or project id.

  • Do not judge quality from a single frame; inspect motion, hair, hands, transparent edges, and fast turns.
  • Do not compare model outputs using different source compression levels.
  • Do not change production defaults without a rollback path and a known sample set.

FAQ

QuestionAnswer
Is Troubleshooting required for every integration?Use it when the topic affects your setup, quality target, or operational workflow.
What should I test before going live?Verify success, failure, timeout, retry, and insufficient-credit paths with realistic video files and the same output format you plan to ship.
How does this connect to the rest of the API?Most workflows connect upload or source URL handling, job creation, status polling, output retrieval, usage tracking, and operational logging.