API Reference

Download Output

Fetch output URL for completed jobs.

Endpoint

GET /api/download/{job_id}

Example Request

curl -X GET https://api.removebgvideo.com/api/download/{job_id}

Response

FieldTypeDescription
successbooleanDownload URL is ready
download_urlstringOutput URL
output_formatstring|nullOutput format

API Contract Notes

  • All clients should handle non-2xx responses as structured error payloads.
  • Use explicit JSON schema validation for request payloads on your side.
  • Treat output_url as an asynchronous artifact and not an immediate response contract.
  • Persist job lifecycle state transitions for auditing and support.

Integration Verification

CheckHow to Verify
AuthenticationCall endpoint with valid and invalid key, confirm 200 vs 401
Rate limitsBurst test and confirm 429 handling with backoff
IdempotencyRetry same request and verify no duplicate side effects
ObservabilityConfirm request_id/job_id appears in logs and dashboards

Output Handling Best Practices

  • Fetch and mirror output_url into your storage if long retention is needed.
  • Attach checksum/hash metadata when archiving outputs.
  • Serve via signed URLs to control access in customer-facing apps.