Request schema
{
"type": "object",
"description": "The body of POST /v1/image. Each operation has its own params schema, with ranges and examples, in https://image.pokt.online/openapi.json. Inputs must be public HTTPS URLs; limits are 50 MB download, 50 MP decoded and 25 MB output, and multi-input operations take up to eight images, 20 MP combined.",
"properties": {
"image_url": {
"type": "string",
"maxLength": 8192,
"description": "The public HTTPS image to read."
},
"operation": {
"type": "string",
"enum": [
"adaptive_threshold",
"add_background",
"animation_info",
"apply_mask",
"auto_orient",
"blur",
"brightness",
"colorspace",
"compare",
"composite",
"compress",
"contact_sheet",
"contrast",
"convert",
"convolve",
"crop",
"deepzoom",
"detect_format",
"difference",
"dilate",
"dominant_color",
"draw_circle",
"draw_line",
"draw_rect",
"draw_text",
"edge_detect",
"emboss",
"entropy",
"erode",
"extract_alpha",
"extract_channel",
"extract_frame",
"extract_page",
"flatten",
"flip",
"gamma",
"grayscale",
"grid",
"hist_equalize",
"histogram",
"hue",
"inspect",
"invert",
"join",
"laplacian",
"local_equalize",
"median",
"merge_channels",
"metadata",
"morphology",
"normalize",
"optimize",
"overlay",
"pad",
"page_info",
"pdf_to_image",
"pixel_sample",
"pyramid",
"rank_filter",
"resize",
"rotate",
"saturation",
"sharpen",
"smartcrop",
"stats",
"strip_metadata",
"threshold",
"thumbnail",
"tile",
"tint",
"trim",
"watermark"
],
"description": "What to do with the image (default inspect)."
},
"params": {
"type": "object",
"description": "The operation's parameters, e.g. {width, height, fit, format} for resize. Operations that need none take {}."
}
},
"required": [
"image_url"
]
}
Response schema
{
"type": "object",
"description": "For POST /v1/image, a JSON object with ok, operation and input (width, height, format, source_bytes). Analyses add their data; transforms add output with width, height, format, bytes, url and expires_in_seconds. A refused request answers ok false with a failure code, e.g. UNSAFE_URL."
}