Crop Video
Crop a rectangular region out of a video by specifying the region's size and position.
API Endpoint
POST /api/v1/tools/crop-video
Accepts multipart form data with a video file and a JSON settings field.
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| width | integer | Yes | - | Crop region width in pixels (minimum 16) |
| height | integer | Yes | - | Crop region height in pixels (minimum 16) |
| x | integer | No | 0 | Horizontal offset from the top-left corner |
| y | integer | No | 0 | Vertical offset from the top-left corner |
Example Request
bash
curl -X POST http://localhost:1349/api/v1/tools/crop-video \
-H "Authorization: Bearer si_your-api-key" \
-F "[email protected]" \
-F 'settings={"width": 640, "height": 480, "x": 100, "y": 50}'Example Response
json
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/clip.mp4",
"originalSize": 12500000,
"processedSize": 5200000
}Notes
- The crop region must fit within the video dimensions. If
x + widthory + heightexceeds the source size, the request returns a 400 error. - Minimum crop size is 16x16 pixels.
- Dimensions are rounded to even numbers as required by most video codecs.
