Skip to main content

StopVideo

Response-body reference for POST /stop_video.

Example

{
"success": true,
"message": "Stopped video f2d9a2d4f94a4d4da6d2a0a2f4d24f01",
"data": {
"video_id": "f2d9a2d4f94a4d4da6d2a0a2f4d24f01"
}
}

When all active video-processing jobs are stopped, data.video_id is null.

Fields

FieldTypeDescription
successbooleanIndicates whether the request succeeded.
messagestringOptional server message.
data.video_idstringVideo-processing job identifier that was stopped, or null when all jobs were targeted.