Video Removal API Reference

Video Removal Submission API

GET/POST/ai/video/removal

Introduction

Video removal product supports automatically removing text within the video as well as removing any content from specified areas. Commonly used in scenarios such as video re-creation.

Supports Chinese or English.

Request Parameters

Parameter	Type	Required	Description
videoUrl	String	Yes	Video URL. Supported specifications: Video formats: mp4, mov, webm, avi, mkv Video file size limit: up to 200MB Video duration limit: 6 minutes Maximum resolution supported: 1080P
language	String	Yes	Source language code, supports Chinese (zh) / English (en). Example value: "en"
artificialTextOnly	Boolean	No	Default is true, which removes only artificially created text; Passing false will remove all text, including both artificial text and natural text on products. Example value: true

Sample Request

The API's maximum response time is 30s. When calling the API, it's recommended to set the request timeout to no more than 30s.

For other programming languages, please refer to Quick Start.

In beta testing, please contact the account manager.

Response Parameters

Parameter	Type	Description
resCode	Number	Response code； 200 indicates a successful call, other response codes can be referred to the error code information.
data	Object	Structured information of the returned result.
data.result.taskId	String	Task ID.
requestId	String	Request ID: used to identify a unique request call.
success	Boolean	Success status; true indicates success, false indicates failure.
resMessage	String	Error message, like "content has sensitive data, please try other input".

Video Removal Query API

GET/POST/ai/video/removal/result

Request Parameters

Parameter	Type	Required	Description
taskId	String	Yes	Task ID.

Response Parameters

Parameter	Type	Description
resCode	Number	Response code； 200 indicates a successful call, other response codes can be referred to the error code information.
data	Object	Structured information of the returned result.
data.videoUrl	String	Processed video link.
requestId	String	Request ID: used to identify a unique request call.
success	Boolean	Success status; true indicates success, false indicates failure.
resMessage	String	Error message，like "content has sensitive data, please try other input".

Response Example

In beta testing, please contact the account manager.

Error Code

Error Code	Error Message	Description
500	system error	System error.
501	rate limit exceed	The current interface has reached the current limit. Please search for the Aidge Product Consultation & Service Group on WeChat using the group number: 105455001046. Join the group to contact us about increasing the current limitation values.
700	video duration exceeds the limit	Video duration exceeds the limit.
701	the video file size exceeds the limit	Video file size exceeds the limit.
702	video format not supported	Video format is not supported.
703	video resolution is not supported	Video resolution is not supported.
801	model failed	Internal call exception. Please search for the Aidge Product Consultation & Service Group on WeChat using the group number: 105455001046. Join the group to contact us for troubleshooting.
1000	content has sensitive data, please try other input	The request parameters contain sensitive information and cannot be processed at this time. Please try a different input.
1001	content control failed, please retry	The risk control service failed. Please search for the Aidge Product Consultation & Service Group on WeChat using the group number: 105455001046. Join the group to contact us.
1002	content risk filter failed, please contact us	Content risk filter failed. Please search for the Aidge Product Consultation & Service Group on WeChat using the group number: 105455001046. Join the group to contact us.