Close Stream API

DeepCleer Close Video Stream Moderation lets the client notify the server to terminate an active video stream moderation task before it ends naturally.

API Description

The Close Video Stream API stops an in-progress video stream moderation task identified by its requestId. Use this endpoint to release DeepCleer stream-pull resources when the upstream live room has ended, when you no longer need moderation results, or when you need to recycle a duplicate-submission dupRequestId returned by the Video Stream Moderation API.

Requirements

Item	Specification
Protocol	HTTP or HTTPS
Method	POST
Encoding	UTF-8
Format	All request and response parameters use JSON

Timeout Suggestion

Recommended request timeout: 7 seconds.

ℹ️
Internal processing timeout is 3 seconds with one automatic retry. Normal response time is within 100 ms. This call is a synchronous control-plane operation — it acknowledges that the close request was accepted. Once accepted, DeepCleer stops pulling the stream and (when returnFinishInfo was set to 1 on the original submission) delivers a final stream-end callback to the original callback URL.

Request

Request URL

Cluster	Endpoint
Singapore Video Stream	`http://api-videostream-xjp.fengkongcloud.com/finish_videostream/v4`

Request Parameters

Parameter	Type	Required	Max Length	Description
`accessKey`	string	Yes	20	API authentication key. The default `accessKey` is sent in your onboarding email.
`requestId`	string	Yes	32	Unique DeepCleer request identifier of the video stream moderation task to close. Use the `requestId` returned by the original Video Stream Moderation submission, or the `dupRequestId` returned when a duplicate submission was detected.

Response

Response Parameters

ℹ️
Parameters other than code, message, and requestId are only guaranteed to be returned when code is 1100.

Parameter	Type	Required	Description
`requestId`	string	Yes	Unique DeepCleer request identifier for this close call.
`code`	int32	Yes	Response code. See Response Codes.
`message`	string	Yes	Response message corresponding to the `code`.

Response Codes

Code	Message	Description
`1100`	Success	The request completed successfully.
`1901`	QPS limit exceeded	The request rate limit has been exceeded.
`1902`	Invalid parameters	One or more request parameters are invalid.
`1903`	Service failure	An internal service error occurred.
`1904`	Stream count limit exceeded	The maximum number of concurrent streams has been reached.
`9101`	Unauthorized operation	The provided `accessKey` does not have permission for this operation.

Examples

Request Example

{
  "accessKey": "YOUR_ACCESS_KEY",
  "requestId": "1639824316368"
}

Response Example

{
  "code": 1100,
  "message": "Success",
  "requestId": "a78eef377079acc6cdec24967ecde722"
}