API reference

Eleven HTTP endpoints for generating, editing and processing images — each one also an MCP tool and a CLI command. Bearer-token auth, JSON in, JSON out.

Request basics

Base URL — https://api.imagemcpserver.com
Auth — Authorization: Bearer <IMAGEMCP_API_KEY>, or x-api-key: <key>
Content type — application/json on every POST
Images in — an https URL or a base64 data URI, in the image field
Images out — a hosted URL, or base64 when you pass responseFormat: "b64_json"

Every image endpoint returns the same top-level shape. The tool-specific output lives under result, and the credit fields appear both at the top level and inside result so either is convenient to read.

200 OK

{
  "success": true,
  "message": "…",
  "deductedCredits": 15,
  "userCredits": 2485,
  "result": { "…": "tool-specific output" }
}

get_user_info is the exception

It predates the envelope and returns { "user": { … } } directly.

Account

GET/auth/user-dataFree

Get user info & credits

Read the authenticated account's profile, plan and remaining credit balance.

MCP tool: get_user_info

GET/playground/modelsFree

List available models

List every live image model you can pass as the `model` parameter, with its credit cost.

MCP tool: list_models

Generation

POST/playground/generateModel cost

Generate image

Turn a text prompt — optionally guided by reference images — into a hosted image.

MCP tool: generate_image

POST/playground/generate-transparentModel cost + 8

Generate transparent image

Generate an image from a prompt and return it as a cut-out PNG with a transparent background.

MCP tool: generate_transparent_image

Editing

POST/playground/editModel cost

Edit image

Change an existing image with natural-language instructions.

MCP tool: edit_image

POST/playground/remove-background8 credits

Remove background

Strip the background from an image and return a transparent PNG.

MCP tool: remove_background

POST/playground/upscale15 credits

Upscale image

Increase an image's resolution while sharpening detail.

MCP tool: upscale_image

Vector

POST/playground/text-to-svg5 credits

Text to SVG

Generate real vector SVG markup — icons, logos and marks — from a prompt.

MCP tool: text_to_svg

Optimisation

POST/playground/compress1 credit

Compress image

Shrink an image's file size with quality control, and report exactly how much was saved.

MCP tool: compress_image

POST/playground/convert-format1 credit

Convert format

Convert an image between PNG, JPEG, WebP and other common formats.

MCP tool: convert_format

Batch

POST/playground/multicallSum of the batch

Multicall (parallel batch)

Run several image tools concurrently in a single request.

MCP tool: multicall