Skip to content
maskostudioDocs

All pages

  • Overview/docs/use-cases
  • Mobile app/docs/use-cases#mobile
  • Website/docs/use-cases#website
  • Desktop/docs/use-cases#desktop
  • AI agents/docs/use-cases#agents
  • Videos/docs/use-cases#videos
  • Brand/docs/use-cases#brand
  • Start building/docs/ai-agents
  • Set up once/docs/ai-agents#set-up-once
  • Ask in plain words/docs/ai-agents#ask-in-plain-words
  • What your agent does/docs/ai-agents#what-your-agent-does
  • MCP server/docs/mcp
  • Masko for Cursor/docs/ai-tools/cursor
  • Masko in ChatGPT/docs/ai-tools/chatgpt
  • Start here/docs/tutorials#start-here
  • All tutorials/docs/tutorials
  • Create your first mascot/docs/tutorials/first-mascot
  • Create an animated character/docs/tutorials/first-animation
  • Make a character talk/docs/tutorials/make-it-talk
  • Put your mascot on your website/docs/tutorials/mascot-on-your-website
  • Guide onboarding with a talking mascot/docs/tutorials/web-onboarding-mascot
  • Add a mascot that celebrates progress and welcomes users back/docs/tutorials/web-progress-companion
  • Add a talking support mascot in the bottom right/docs/tutorials/web-support-mascot
  • Show a mascot while your AI thinks/docs/tutorials/ai-loading-mascot
  • Give your AI agent a face/docs/tutorials/ai-agent-face
  • Animate the mascot you already have/docs/tutorials/animate-your-mascot
  • How to make Telegram stickers/docs/tutorials/telegram-stickers
  • How to make Discord stickers/docs/tutorials/discord-stickers
  • Quickstart: your first animation/docs/quickstart
  • Terminal quickstart/docs/terminal
  • API keys and workspaces/docs/authentication
  • CLI browser login/docs/authentication/cli
  • How mascots work/docs/how-mascots-work
  • Credits and costs/docs/credits
  • From text/docs/create/from-text
  • From an image/docs/create/from-image
  • From a website/docs/create/from-website
  • From a brand book/docs/create/from-brand-book
  • Reference images/docs/manage/references
  • What you can generate/docs/generation
  • Pose-to-animation walkthrough/docs/generate/workflow
  • Images and poses/docs/generate/images
  • Animations/docs/generate/animations
  • Talking animations/docs/generate/talking
  • Logos, backgrounds and stickers/docs/generate/design-assets
  • Cursor follower/docs/generate/cursor-follower
  • Batch generation/docs/generate/batch
  • Image and video exports/docs/manage/media-exports
  • Canvases and releases/docs/canvas
  • Build a canvas/docs/canvas/build
  • Canvas templates/docs/canvas/templates
  • Generate canvas assets/docs/canvas/generate-all
  • Export a canvas/docs/canvas/export
  • Overview and demo/docs/player
  • Play one animation/docs/player/one-animation
  • Play a canvas/docs/player/canvas
  • Hosting and file formats/docs/generate/cdn
  • File sizes/docs/generate/file-sizes
  • Float a mascot on your Mac/docs/integrations/desktop
  • Jobs and polling/docs/manage/jobs
  • Webhooks/docs/manage/webhooks
  • Manage mascots and assets/docs/manage/collections
  • All endpoints/docs/reference
  • Requests and responses/docs/reference/conventions
  • Errors and recovery/docs/reference/errors
  • Command line reference/docs/terminal/commands
  • TypeScript SDK/docs/sdk/typescript
  • Changelog/docs/reference/changelog
  • Migrate to mascots and canvases/docs/manage/studio-migration
Get an API key
Documentation

Masko MCP server

The Masko MCP server gives your AI app tools to create a mascot, animate it, build an interactive canvas and bring the files into your project. You ask in plain words, and the app calls the tools. One server works for every app:

https://masko.ai/api/mcp

Connect your app

Your app connects in one of two ways:

  • Sign in, in Claude Code, Cursor, Claude, ChatGPT and opencode. Your app opens masko.ai. You sign in, choose your personal or team workspace and approve. You never paste a key. A team connection needs an owner or admin.
  • API key, in Codex, VS Code, Claude Code run by scripts, and other apps. Open Developers → API keys, choose Create API key and keep Read + Write. Copy the key: it is shown once. It belongs to the workspace you are in when you create it. Then set it in your terminal:
export MASKO_API_KEY=masko_YOUR_KEY

Add that line to your shell profile, such as ~/.zshrc, so every new terminal has it. Never commit the key or put it in browser code.

Pick your app for its setup. The MCP tab of the Developers page shows the same steps with copy buttons.

Your app

Sign in, no key. Run this in your terminal:

claude mcp add --transport http --scope user masko https://masko.ai/api/mcp

Start Claude Code, run /mcp, choose masko and Authenticate. Your browser opens masko.ai: sign in, choose your workspace and approve. --scope user adds Masko to all your projects. Leave it out to add Masko to this project only. From the terminal, claude mcp list checks it.

Or use your API key, for scripts and machines without a browser. Run this in the terminal where MASKO_API_KEY is set:

claude mcp add --transport http --scope user masko https://masko.ai/api/mcp \
  --header "Authorization: Bearer $MASKO_API_KEY"

The command saves the key in your Claude Code settings on this computer. To share the setup with your team in a repository, put this in .mcp.json instead. Each person keeps their own MASKO_API_KEY:

{
  "mcpServers": {
    "masko": {
      "type": "http",
      "url": "https://masko.ai/api/mcp",
      "headers": { "Authorization": "Bearer ${MASKO_API_KEY}" }
    }
  }
}

Check the connection

Ask your agent:

Show my Masko projects, mascots and credit balance. Don't generate anything.

Reading is free. If something is off:

What you seeWhat to do
The app shows no Masko toolsRun /mcp (Claude Code, Codex) or open the app's MCP settings, check that masko is connected, then restart the app.
Codex says Masko isn't available, but /mcp lists itAsk it to "use the masko MCP tools". Codex can keep a server's tools out of sight until it searches for them.
A browser sign-in opens in Claude CodeApprove it on masko.ai: Claude Code connects without a key. To use a key instead, add Masko with the --header command above.
A browser sign-in opens and fails in CodexThe key is missing, revoked, or not a Read or Read + Write API key. Check echo $MASKO_API_KEY in the terminal that starts the app, then add Masko again.
"This connection is read-only"Use a Read + Write key, or reconnect and approve write access.
Other projects or credits than you expectedThe key or connection belongs to another workspace. Create the key in the right workspace, or reconnect and choose it.

Then ask in plain words

Create a friendly mascot for this app with Masko and make it wave hello.
Tell me the cost first.
When someone finishes a lesson, make the mascot celebrate,
then go back to its idle loop.
Add these animations to this React app, with no flicker between clips.

The agent shows you the cost before anything paid, follows each job until the files are ready, installs the Masko player and connects your app's events to it. More prompts are in Build with your AI agent.

What the tools do

AreaTools
Account and creditsget_account, get_credits, create_credit_checkout, get_credit_checkout (the two checkout tools are not offered in ChatGPT)
Projects and mascotslist_projects, create_project, list_mascots, get_mascot, create_mascot, update_mascot (name, context and room for movement), import_mascot_image, upload_mascot_image
Images, backgrounds and animationsgenerate_mascot_image, suggest_backgrounds, make_background, animate_mascot
Voices and talkingget_mascot_voice, suggest_mascot_voices, sample_mascot_voices, keep_mascot_voice, make_talking_animation
Jobs and filesget_job, list_jobs, get_asset, list_assets, export_asset, publish_mascot_assets, get_mascot_cdn
Interactive canvaseslist_canvases, create_canvas, get_canvas, save_canvas, validate_canvas, estimate_canvas_generation, generate_canvas, get_canvas_status, repair_canvas_media, list_canvas_history, release_canvas, get_release_delivery
Guidesget_integration_guide
Feedbacksend_feedback

get_release_delivery returns a release's playback files for the web, iPhone and iPad, Android or Masko for Mac; with formats: av1, apps get the lighter AV1 files the Masko player plays. For talking animations, make_talking_animation first runs free with dry_run to show the script and cost.

Good to know

  • Credits. Generation spends the connected workspace's Masko credits, not your AI app's subscription. Reading, estimates and job checks are free. See credits and costs.
  • Your own image. The server runs on masko.ai and cannot read files on your computer. Give it an HTTPS image URL, upload the image on masko.ai first, or let your agent upload it from the terminal with masko studio POST upload --file image.png (terminal quickstart) or POST /v1/upload.
  • Hosting. New mascots made through the MCP server start with public hosting off, and their file links expire. Ask the agent to publish the assets before you use their links in a public app.
  • A stopped run. Ask the agent to check its existing jobs before it generates again, so you never pay twice.
  • Limits. 120 requests per minute per connection.
  • Feedback. Your agent can tell the Masko team what is confusing, broken or missing, or what works well, with send_feedback. It works on read-only connections too. See Send feedback to Masko.

Pages you will use

PageWhat you do there
Developers → MCPCopy the setup for your app, and disconnect the apps you signed in with
Developers → API keysCreate or revoke the key for Claude Code, Codex, VS Code and other apps
BillingBuy credits

Disconnecting an app or revoking a key stops its future requests. It does not delete your mascots or cancel a generation that already started.

Without MCP

Any coding agent that runs commands can use the REST API with MASKO_API_KEY and the docs at masko.ai/llms.txt: see Build with your AI agent. To work from the terminal yourself, see the terminal quickstart.