2026-06-17 11:11:37 +08:00
|
|
|
---
|
|
|
|
|
description: Crop a region out of a video.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Crop Video
|
|
|
|
|
|
|
|
|
|
Crop a rectangular region out of a video by specifying the region's size and position.
|
|
|
|
|
|
|
|
|
|
## API Endpoint
|
|
|
|
|
|
2026-06-21 00:12:59 +08:00
|
|
|
`POST /api/v1/tools/video/crop-video`
|
2026-06-17 11:11:37 +08:00
|
|
|
|
|
|
|
|
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
|
2026-06-21 00:12:59 +08:00
|
|
|
curl -X POST http://localhost:1349/api/v1/tools/video/crop-video \
|
2026-06-17 11:11:37 +08:00
|
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
|
|
|
-F "file=@clip.mp4" \
|
|
|
|
|
-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 + width` or `y + height` exceeds 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.
|