Caption Removal API Documentation

Overview

Detect and cleanly remove embedded captions, subtitles, or text overlays from video frames using AI inpainting.

Primary Endpoint

POST/api/v1/userCaptionRemoval/start

Start caption removal task

Request Parameters

Name	Type	Required	Description
name	string	Yes	Name of the caption removal task
source_url	string	Yes	URL of the source video
webhook_url	string	No	HTTPS URL to receive task.completed / task.failed notifications. Best-effort delivery, single attempt, no retries; clients should treat the detail API as the source of truth.
webhook_token	string	No	Optional plaintext token returned in the X-A2e-Webhook-Token header so receivers can verify the request originated from a2e.

Request Example

curl -X POST "https://www.a2e.com.cn/api/v1/userCaptionRemoval/start" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Remove captions from video",
  "source_url": "https://example.com/video.mp4",
  "webhook_url": "https://your-server.example.com/a2e/webhook",
  "webhook_token": "a-shared-secret"
}'

Related Endpoints

POST/api/v1/userCaptionRemoval/start

Start caption removal task

GET/api/v1/userCaptionRemoval/allRecords

Get all task records

GET/api/v1/userCaptionRemoval/allProcessing

List processing records

POST/api/v1/userCaptionRemoval/batchDetail

Batch query task details

GET/api/v1/userCaptionRemoval/{_id}

Get task details

DELETE/api/v1/userCaptionRemoval/{_id}

Delete caption removal task

POST/api/v1/userCaptionRemoval/retry

Retry a failed task

Responses

200

Caption removal task started successfully

400

Bad Request - Invalid parameters

401

Unauthorized - Invalid or missing bearer token