Image Processing API

Upload and manage enhanced images with AI. All requests use multipart/form-data. Some endpoints are restricted to enterprise users.

Usage Guidelines

  • You must be an authenticated user with Pro Plan Subscription to use our API for backend or server side calls. To make client side calls from browser you must be on Enterprise plan and register your domain.
  • We use JWT for authenticating user. The payload contains subject, name, authorities, iat and exp.
  • The validity of token is 3 days. Make sure you implement functionality to get new token on every 72 hours.
  • The JWT token system doesn't provide feature to revoke token. So make sure to store them hashed or encrypted.
  • If you are an user who signed up using Google then use forget password to reset password and set a new one.

Login

POST

Login with your email and password to get access token

Endpoint
https://api.cropedly.com/auth/v1/login
Consumes:
multipart/form-data
Inputs
  • email (string) – required: Email of your account.
  • password (string) – required: Password of your account.
Response

200 OK - Object containing token

Enhance Image(s)

POST🔒 Auth Required

Upload and enhance one or more images.

Endpoint
https://api.cropedly.com/images/v1
Consumes:
multipart/form-data
Inputs
  • images (file[]) – required: One or more images to enhance.
Response

200 OK – List of enhanced image objects with URL, MIME type, and size.

Upload Enterprise Images

POST🔒 Auth Required

Upload reference images for enterprise workflows.

Endpoint
https://api.cropedly.com/images/v1/enterprise-resources/images/upload
Consumes:
multipart/form-data
Inputs
  • images (file[]) – required: Multiple image files to upload.
Response

204 No Content – Files uploaded successfully.

Get All Enterprise Images

GET🔒 Auth Required

Fetches all uploaded reference images for enterprise accounts.

Endpoint
https://api.cropedly.com/images/v1/enterprise-resources/images
Response

200 OK – List of image metadata (URL, size, mime).

Get Single Image by ID

GET🔒 Auth Required

Retrieve a specific enterprise image by ID.

Endpoint
https://api.cropedly.com/images/v1/enterprise-resources/images/{id}
Inputs
  • id (string (path)) – required: Image ID to fetch.
Response

200 OK – Returns image metadata.

Delete Images by IDs

DELETE🔒 Auth Required

Delete multiple enterprise images by passing their IDs as query params.

Endpoint
https://api.cropedly.com/images/v1/enterprise-resources/images?ids=...
Inputs
  • ids (string[] (query)) – required: List of image IDs to delete.
Response

204 No Content – Selected images deleted successfully.