POST /v1/imaging/image-crop

Crop an image

An exact box, or an aspect ratio cropped from the centre — whichever you have in mind.

Cut an image down now No key, no code — 2 credits either way.

curl -X POST "$DOATHING_API/v1/imaging/image-crop" \
  -H "x-api-key: $DOATHING_KEY" \
  -H "content-type: application/json" \
  -d '{"file": {"filename": "photo.jpg", "content_type": "image/jpeg", "data_b64": "<base64>"}, "options": {"aspect": "1:1"}}'

An exact box, or an aspect ratio cropped from the centre — whichever you have in mind.

Crop an image to an explicit box or to an aspect ratio anchored at a chosen position.

Input

Send a file object with base64 data_b64, its content_type and a filename. Accepted types: image/png, image/jpeg, image/webp, image/gif, image/tiff.

The declared type is not trusted — the bytes are sniffed and a contradiction is rejected rather than corrected.

Response

The result carries your remaining balance alongside it, so you can track spend without a second call.

{
  "box": {
    "left": 504,
    "top": 0,
    "right": 3528,
    "bottom": 3024
  },
  "cropped": {
    "width": 3024,
    "height": 3024
  },
  "request_id": "37f01edb-0163-42a1-ac51-0acaef979800",
  "credits_remaining": 96
}

Cost

2 credits per call, whether it is run from the site or from the API — the credential differs, the price does not. A new account starts with 20 credits.

A rejected request still costs a credit: the authorizer decrements before the tool validates. A call rejected for a missing or invalid key is free.

Parameters

Generated from the endpoint’s own validation, so this is exactly what it accepts. A body field goes at the top level; an option goes inside options.

NameInTypeDefaultNotes
aspectoptionsstringCrop to a ratio like '16:9' instead of a box.
anchoroptionsstring"centre"Where the aspect crop sits: centre, top, bottom, left or right. one of centre, center, top, bottom, left, right
widthoptionsintegerBox width. 1 to 20000
heightoptionsintegerBox height. 1 to 20000
leftoptionsinteger0Left edge of the crop box. 0 to 20000
topoptionsinteger0Top edge of the crop box. 0 to 20000
qualityoptionsinteger901 to 100