API Documentation

Integrate AI photo colorization with HTTP POST (multipart/form-data). Every request must include your end-user X-Api-Key header — credits deduct per successful job and the response includes a public download URL. Create a key in the Console after signing in and purchasing credits.

Getting started

Create an end-user API key in the Console (requires a signed-in account with available credits).
POST https://api.aivelo.net/api/v1/colorize with header X-Api-Key on every call.
Send multipart/form-data with field image: binary file, or text (http(s) URL, base64, or data URL).
Optional field model: large or tiny.
Optional add-ons: clean_scratches (Smart Damage Repair, +1 credit) and face_remaster (AI Clarity Boost, +2 credits). Send true or false.

Endpoint

Replace {MONITOR_URL} with your Monitor deployment origin (no trailing slash).

POSThttps://api.aivelo.net/api/v1/colorize

Credits

At least 1 credit per successful colorization. Optional add-ons (scratch repair +1, clarity boost +2) apply when those fields are enabled on the request — same as the web workbench.

Request

Name	In	Description
X-Api-Key	Header	Required. End-user API key from the Console. Credits deduct per successful job (see Credits section).
image	Multipart	Required. File (≤ 25 MB) or text — http(s) URL, base64, or data URL; format is auto-detected.
model	Multipart	Optional. "large" (default, better quality) or "tiny" (faster inference).
clean_scratches	Multipart	Optional. Smart Damage Repair. "true" or "false" (default false). +1 credit when enabled.
face_remaster	Multipart	Optional. AI Clarity Boost. "true" or "false" (default false). +2 credits when enabled.

Response

On success, returns application/json containing a public download URL for the colorized image.

{ "outputUrl": "https://…/out.png" }

Field / Status	Description
outputUrl	String. The colorized image URL (publicly accessible, time-limited CDN link).
Content-Type	application/json; charset=utf-8
200	Success.

Sample code

Examples call Monitor directly at https://api.aivelo.net.

Input

Model

Language

Sample code

curl -X POST \
  -H 'X-Api-Key: INSERT_YOUR_USER_API_KEY' \
  -F 'image=@/path/to/file.jpg' \
  -F 'model=large' \
  'https://api.aivelo.net/api/v1/colorize'
# Response: {"outputUrl":"https://…/out.png"}

HTTP errors

Status	Typical cause
400	Invalid multipart, conflicting `image` file+text, or empty/invalid `image` content.
401	Missing, invalid, or inactive X-Api-Key.
403	Insufficient credits on the linked account.
429	Rate limit or throttling exceeded.
503	Application integration is not enabled or not configured.
502	Upstream provider error or unreachable.