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
  • API keys and workspaces/docs/authentication
  • 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, scenes and stickers/docs/generate/design-assets
  • Cursor follower/docs/generate/cursor-follower
  • Batch generation/docs/generate/batch
  • 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
  • Play a mascot in your app/docs/integrations/playback
  • Hosting and file formats/docs/generate/cdn
  • File sizes/docs/generate/file-sizes
  • Image and video exports/docs/manage/media-exports
  • Terminal quickstart/docs/terminal
  • Command line reference/docs/terminal/commands
  • CLI browser login/docs/authentication/cli
  • Float a mascot on your Mac/docs/integrations/desktop
  • TypeScript SDK/docs/sdk/typescript
  • 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
  • Changelog/docs/reference/changelog
  • Migrate to mascots and canvases/docs/manage/studio-migration
Get an API key
Documentation

Terminal quickstart

The masko command signs in to your Masko account and calls the Studio API. It runs on macOS 14 or later, on Apple Silicon. It does not show mascots on screen. To float a mascot on your Mac, see Float a mascot on your Mac.

Install

curl -fsSL https://releases.masko.ai/cli/install.sh | sh

This installs the signed, notarized CLI at ~/.local/bin/masko, with versioned builds in ~/.masko/versions/. No Xcode, Node.js or checkout is needed. If asked to add Masko to your PATH, add this line to your shell profile:

export PATH="$HOME/.local/bin:$PATH"

To install with analytics off, put the variable on the right side of the pipe:

curl -fsSL https://releases.masko.ai/cli/install.sh | MASKO_TELEMETRY_DISABLED=1 sh

MASKO_TELEMETRY_DISABLED=1 or DO_NOT_TRACK=1 also disables reporting for one process.

Sign in and check your account

masko login
masko whoami
masko credits

login prints a URL, opens your browser, and returns after you approve. Choose your account and workspace in the browser. Over SSH or on a remote machine, use masko login --device --no-browser. logout signs out of the saved login.

Call the Studio API

masko studio GET mascots --json
masko studio GET 'canvases?project_id=PROJECT_ID' --json
masko studio POST canvases --file canvas.json --json

Paths start with mascots, canvases, projects, jobs, assets or upload. Request bodies match the Core OpenAPI. See the studio migration guide for current route names.

Download assets

masko assets show ASSET_ID --json
masko assets download ASSET_ID --output image.png

Downloads never overwrite an existing file.

Update or choose a version

Run the install command again for the latest version. Your sign-in is kept. To install a specific version:

curl -fsSL https://releases.masko.ai/cli/install.sh | MASKO_VERSION=0.1.0 sh
masko --version

Next steps