API & MCP

MCP Server

Connect any MCP agent to PixelZ: generate pixel art, pixelize images, remove backgrounds, create effects and animate sprites.

PixelZ runs a remote Model Context Protocol server. Claude, ChatGPT, Codex, Cursor, VS Code and other MCP clients connect to it with your PixelZ account.

Every plan can connect, the free one included. The effect library (list_effects, render_effect, get_effect_source) uses no credits; the other tools use your account's credits at the same prices as the app. When they run out, get more with a plan.

Server URL

https://api.pixelz.io/mcp

The server uses Streamable HTTP. When a client connects, it opens a PixelZ page where you sign in and allow access, so no API key is needed. Clients that can't sign in send an API key instead.

Connect your client

Claude

In Claude, open Settings → Connectors → Add custom connector, paste the server URL and click Connect. It works on the web, desktop and mobile. Claude's guide

Claude Code

claude mcp add --transport http --scope user pixelz https://api.pixelz.io/mcp

Then run /mcp, pick pixelz and sign in. Claude Code MCP docs

Codex

codex mcp add pixelz --url https://api.pixelz.io/mcp
codex mcp login pixelz

The login opens the PixelZ sign-in. The ChatGPT desktop app and the Codex IDE extension share this setup. For scripts and CI, use an API key from PIXELZ_API_KEY in ~/.codex/config.toml instead. Codex MCP docs

[mcp_servers.pixelz]
url = "https://api.pixelz.io/mcp"
bearer_token_env_var = "PIXELZ_API_KEY"

ChatGPT

On the web, add PixelZ as a custom MCP server in ChatGPT Plugins: enter the server URL, choose OAuth and sign in. Availability depends on your ChatGPT plan and workspace settings.

Cursor

Add to ~/.cursor/mcp.json, then sign in when Cursor asks. Cursor MCP docs

{
  "mcpServers": {
    "pixelz": {
      "url": "https://api.pixelz.io/mcp"
    }
  }
}

VS Code

Add to .vscode/mcp.json, then sign in when VS Code asks. VS Code MCP docs

{
  "servers": {
    "pixelz": {
      "type": "http",
      "url": "https://api.pixelz.io/mcp"
    }
  }
}

Other clients

Any client that supports Streamable HTTP and OAuth needs only the server URL. If yours can't sign in but can send headers, use an API key instead, and keep it in the client's secret settings rather than a shared config file:

Authorization: Bearer YOUR_API_KEY

Tools

ToolWhat it doesCredits
generate_imagePixel art from a prompt, transparent by default. PixelZ Core v1 draws square sprites of 16, 24, 32, 48, 64, 96, 128 px; Gemini or GPT also 256 and 512 px, and 16:9 or 9:16. Saved to your Assets.pixelz 3; gemini by quality: fast 2, standard 4, pro 8; gpt by quality: fast 2, standard 3, pro 5
edit_imageChanges one thing on a sprite and keeps the rest: a weapon, an outfit, a material ("make it a blue crystal"), a skin or a pose.3 credits
generate_in_styleDraws a new object in a reference sprite's style, palette and outline, e.g. a shield to match a sword.3 credits
generate_8_directionsTurns a cut-out sprite, a character or an object, to face 8 directions on one 3×3 sheet.5 credits
pixelize_imageSnaps an image to its pixel grid and reduces the palette; can remove the background. save_to_assets keeps the result in your Assets.free
remove_backgroundMakes the background transparent. save_to_assets keeps the result in your Assets.free
list_effectsThe hand-tuned effect library: hits, blood, lightning, water, burn, freeze, shields, a black hole, a tornado… with their params.free
render_effectRenders a library effect as a strip and a GIF, sized to your character when you pass its sprite; returns the frame size and the origin to put on the character.free
get_effect_sourceA library effect's TypeScript, and with core the small engine it runs on: play it live in a JS game, or let the agent write a new effect from it without spending credits.free
animate_spriteAnimates a sprite up to 256×256: walk, run, attack, idle… model v1.1 is best at loops; v1.5 follows unusual or very specific motions. The sprite gets room to move, centred by default, so the frames come back larger than the sprite: a 32 px character in 72×72.v1.1 8, v1.5 11
upload_imageGives an upload address and a curl command for a file on your disk, and the upload: id to pass as image.free
get_jobThe status and result of a job; wait (up to 50 s) holds the call until it ends.free
get_creditsCredits left this month.free

Results come back as download URLs that can go straight into the next tool. generate_image, edit_image, generate_in_style, generate_8_directions and animate_sprite answer at once with a running job: an image takes a minute or two, an animation one to three. The agent calls get_job with wait until it is done.

Prompts

The server also offers ready-made prompts, shown as slash commands in clients that support them, e.g. /pixelz:sprite in Claude Code: sprite, animate, pixelize and effect. Each asks what you want when you haven't said it, runs the tool and saves the result into your project.

Input images

  • A public https URL.
  • A file on your disk, sent with upload_image. Send the file within 60 minutes; its id works until then.
  • Base64 data or a data URL, for small images only.

PNG or JPEG, up to 2 MB and 1024×1024 pixels.

Credits and limits

  • A call that fails is refunded, except an image that was generated but couldn't be finished, which stays charged and can be retried in the app.
  • Effects cost nothing: your agent writes them in the library's format and render_effect draws and checks them.
  • 60 requests a minute in bursts of up to 20, shared by every key and app on your account. 4 calls and 10 jobs (images and animations) at once. 1000 calls of the free tools (pixelize_image, remove_background) per 24 hours.
  • Results are deleted after 30 days, effects included. Generated images, animations and results saved with save_to_assets stay in PixelZ.

Disconnect an app

Apps you signed in with are listed in Settings → API & MCP. Disconnect one there and it loses access at once; it can't come back until you allow it again. Keys are revoked on the same page.