usely.tools

API reference

POST /api/v1

Performs image, 3D and developer tools. Costs 1 credit per successful call. Failed operations are never charged.

Request

Provide the image in exactly one of these ways:

  • multipart/form-data with an image_file field.
  • JSON body with image_url (publicly reachable URL).
  • JSON body with image_base64 (raw base64, no data-URL prefix).

Parameters

NameTypeDefaultDescription
sizestringautoauto · preview (≤0.25 MP) · full
formatstringpngpng (transparent) or jpg
bg_colorstring—Hex like #ffffff to composite a solid background.
cropbooleanfalseCrop to the subject’s bounding box.

Headers

HeaderDescription
AuthorizationRequired. Bearer ut_live_…
Acceptapplication/json for a JSON response; otherwise binary image.
Idempotency-KeyOptional. Replays return the original response and are never double-charged.

Response

By default the response body is the processed image (Content-Type: image/png or image/jpeg) with these headers:

  • X-Credits-Charged — credits deducted for this call.
  • X-Credits-Remaining — your balance after the call.
  • X-RateLimit-Limit / X-RateLimit-Remaining

Send Accept: application/json to receive JSON instead:

{
  "data": {
    "image_base64": "iVBORw0KGgo…",
    "width": 1024,
    "height": 768
  },
  "credits_charged": 1,
  "credits_remaining": 248
}

Examples

curl -X POST https://usely.tools/api/v1 \
  -H "Authorization: Bearer ut_live_YOUR_KEY" \
  -F "image_file=@photo.jpg" \
  -o tools.png