# Crop image

Crop an image to a rectangle in pixels, or to an aspect ratio such as 16:9 or 1:1 around its centre or an edge.

- Endpoint: `POST https://setget.net/v1/tools/image-crop` with JSON `{"input": {...}}` (add `"wait": 30` to hold the reply until the job finishes)
- MCP: `run_tool` with `slug` = `image-crop`
- Page: https://setget.net/tools/image-crop

## Files in, files out

This is a file tool. Its file inputs take file references, not file contents and not web addresses.

- Get a reference by uploading: `curl -T FILE https://setget.net/drop/` prints a line `ref  <id>/f1`. Or `POST https://setget.net/v1/drops` with `{"files":[{"name","size"}]}`, PUT the bytes to the returned `upload.url` with the listed headers, and use the file's `ref`. Over MCP use the `drop` tool. A file under about 700 KB can also be sent in place as a `data:<type>;base64,<content>` URI.
- Uploads are at most 100 MB per file, are readable by anyone with the link, and expire (one hour by default). Programs are refused.
- The tool runs as a job. The reply is `{"tool", "ms", "result", "files", "job"}`: `result` is JSON, and every result file comes back in `files` as `{"name", "size", "content_type", "kind", "url", "ref"}`. Download it from `url`, or pass `ref` as the input of another file tool.
- A job still running when the wait ends answers 202 with `job`. Follow it with `GET https://setget.net/v1/jobs/<id>?wait=30`, or stream progress from `GET https://setget.net/v1/jobs/<id>/events` (over MCP: the `job` tool). A person can watch it at `job.url`.

## Inputs

- `image` (required, file, a file reference such as `DROP_ID/f1`, accepts image): The image to crop.
- `x` (optional, integer, range 0..): Left edge of the crop, in pixels from the left of the image. Leave empty to place the crop by gravity.
- `y` (optional, integer, range 0..): Top edge of the crop, in pixels from the top of the image. Leave empty to place the crop by gravity.
- `width` (optional, integer, range 1..): Width of the crop in pixels.
- `height` (optional, integer, range 1..): Height of the crop in pixels.
- `aspect` (optional, string): Crop to this shape instead of a size, written width:height, for example 16:9 or 1:1. The largest area of that shape is kept.
- `gravity` (optional, string, one of `center`, `top`, `bottom`, `left`, `right`, default `"center"`): Which part to keep when x or y is not given.

## Example 1: Cut out a rectangle

Upload first. Each placeholder below stands for the reference of one upload: `DROP_ID/f1` = [sample.jpg](https://setget.net/static/samples/sample.jpg).

```json
{"input":{"image":"DROP_ID/f1","x":40,"y":20,"width":200,"height":120},"wait":30}
```

## Example 2: Largest centred square

Upload first. Each placeholder below stands for the reference of one upload: `DROP_ID/f1` = [sample.jpg](https://setget.net/static/samples/sample.jpg).

```json
{"input":{"image":"DROP_ID/f1","aspect":"1:1"},"wait":30}
```

## Example 3: 16:9 from the top

Upload first. Each placeholder below stands for the reference of one upload: `DROP_ID/f1` = [sample.png](https://setget.net/static/samples/sample.png).

```json
{"input":{"image":"DROP_ID/f1","aspect":"16:9","gravity":"top"},"wait":30}
```

**How do I find the pixel positions?** Open the image in any editor and hover over the corner you want: most show the x and y under the pointer. x counts from the left edge and y from the top, starting at 0.

**Can I crop to a size without giving x and y?** Yes. Give width and height only and the crop is placed by gravity: the centre by default, or against the top, bottom, left or right edge.

**Does cropping reduce quality?** PNG, GIF and other exact formats lose nothing. A JPG is saved again at high quality, which changes it very slightly.
