# Masko > Create mascots for your product and bring them to life. Masko includes a web creation studio, a REST API, a Mac desktop companion, a mascot marketplace and Masko Life. Use Studio or the REST API to generate assets. Use exported files or hosted URLs in your own product, and connect its events to authored mascot behavior. Agent integrations, desktop notifications and the Mac runtime belong to Masko for Mac. Masko Life is the companion you raise and care for. ## What you can do with Masko Use cases by where the mascot lives. "Works today" means Masko makes it end to end. "You assemble it" means Masko makes the mascot, its clips and voice, and your own code joins them. Each use case links to its tutorial when one exists, otherwise to the most relevant guide. Overview with the results playing: https://masko.ai/docs/use-cases ### Mobile app - Add a coach that shows every exercise (works today): One animation per exercise, plus cheers between sets. Guide: https://masko.ai/docs/generate/animations.md - Show a mascot while your AI is thinking (works today): Thinking loops for long answers, then a small celebration. Tutorial: https://masko.ai/docs/tutorials/ai-loading-mascot.md - Guide your onboarding with a talking mascot (works today): One talking clip per step, in your mascot’s own voice. Tutorial: https://masko.ai/docs/tutorials/make-it-talk.md - Celebrate streaks and progress (works today): Clips for streaks, levels and finished lessons. Guide: https://masko.ai/docs/generate/animations.md - Grow a character that evolves with your users (works today): A state machine that hatches, grows and roars as they progress. Guide: https://masko.ai/docs/use-cases/evolving-character - Make a focus timer where the mascot falls if you leave (works today): It slips when you leave the app and falls after 10 seconds. Guide: https://masko.ai/docs/use-cases/focus-timer - Build a focus or Pomodoro app with a little buddy (works today): A focus loop, a break loop and a nudge when time is up. Guide: https://masko.ai/docs/generate/animations.md - Make a kids’ app with a character that talks to them (works today): A character that talks to kids in their language. Guide: https://masko.ai/docs/generate/talking.md - Put a mascot on empty screens and errors (works today): Poses and loops that make an empty list feel less cold. Guide: https://masko.ai/docs/generate/images.md - Use your mascot in your app icon and App Store screenshots (works today): An app icon and poses, ready for store images. Guide: https://masko.ai/docs/generate/design-assets.md - Ship your mascot as Lottie or transparent video on iOS and Android (works today): Lottie, dotLottie, transparent video, GIF and PNG frames. Guide: https://masko.ai/docs/manage/media-exports.md ### Website - Guide onboarding with a talking mascot (you assemble it): Welcome new users, explain each setup step, and celebrate their first completed action. Tutorial: https://masko.ai/docs/tutorials/web-onboarding-mascot.md - Add a mascot that celebrates progress and welcomes users back (you assemble it): React to completed habits and milestones, then welcome returning users to their next activity. Tutorial: https://masko.ai/docs/tutorials/web-progress-companion.md - Add a talking support mascot in the bottom right (you assemble it): Greet visitors when clicked, offer common help topics, and open the support chat. Tutorial: https://masko.ai/docs/tutorials/web-support-mascot.md ### Desktop - Get a cute desktop pet (works today): Masko for Mac puts a mascot on your screen. Guide: https://masko.ai/docs/integrations/desktop.md - Make your own mascot your desktop pet (works today): Make a mascot in Studio, then open it on your Mac. Guide: https://masko.ai/docs/integrations/desktop.md - Get a companion that reacts to your coding agents (works today): Reacts when Claude Code, Codex or Cursor works or needs you. Guide: https://masko.ai/docs/integrations/desktop.md - Run a Pomodoro with your pet (works today): The Focus and Break app times sessions with your pet. Guide: https://masko.ai/docs/integrations/desktop.md - Get water, break and breathing reminders from your pet (works today): Your pet acts out reminders on a timer, like a sip of water. Guide: https://masko.ai/docs/integrations/desktop.md - Make your pet react to your music (works today): Your pet reacts to the music you play. Guide: https://masko.ai/docs/integrations/desktop.md - Know when your Mac needs attention, through your pet (works today): Your pet reacts when something needs you, not a banner. Guide: https://masko.ai/docs/integrations/desktop.md - Make a desktop pet for your own app (works today): Every reaction animated, plus the state machine to play it. Guide: https://masko.ai/docs/use-cases/desktop-pet - Hear your pet say what your agent did (coming, needs a build first): Text bubbles today. Speaking them needs a build first. Guide: https://masko.ai/docs/integrations/desktop.md ### AI agents - Give your AI agent a face (works today): Idle, thinking and done clips your agent switches between. Tutorial: https://masko.ai/docs/tutorials/ai-agent-face.md - Let your AI agent create your mascot and its animations (works today): Through the API or MCP, it makes the mascot and its moves. Guide: https://masko.ai/docs/ai-agents.md ### Videos - Announce a new feature (works today): A short talking video in your mascot’s own voice. Tutorial: https://masko.ai/docs/tutorials/make-it-talk.md - Make a release video for each version (works today): One talking clip per release, scripted from your notes. Tutorial: https://masko.ai/docs/tutorials/make-it-talk.md - Present a product demo or explainer (works today): Your mascot talks through the product. Tutorial: https://masko.ai/docs/tutorials/make-it-talk.md - Make a video tutorial (works today): Step-by-step talking clips that show and tell. Tutorial: https://masko.ai/docs/tutorials/make-it-talk.md - Make videos for kids: lessons, stories, “repeat after me” (works today): Lessons and stories, with pauses for kids to repeat. Tutorial: https://masko.ai/docs/tutorials/make-it-talk.md - Teach a language with a mascot that speaks several (works today): One voice, many languages: Bonjour, Hola, Ciao. Tutorial: https://masko.ai/docs/tutorials/make-it-talk.md - Post skits on TikTok, Reels and X (works today): Short skits where your mascot whispers, shouts and laughs. Tutorial: https://masko.ai/docs/tutorials/make-it-talk.md - Send a personal video to each customer (works today): One talking clip per customer, with their name in it. Tutorial: https://masko.ai/docs/tutorials/make-it-talk.md - Send a birthday or holiday greeting with the person’s name (works today): A greeting your mascot says out loud, with their name. Tutorial: https://masko.ai/docs/tutorials/make-it-talk.md - Play your update in a video call instead of attending (works today): A talking clip of your update to play in the call. Tutorial: https://masko.ai/docs/tutorials/make-it-talk.md - Recap each meeting, or send a weekly team update (you assemble it): You turn the transcript into a line. Your mascot says it. Guide: https://masko.ai/docs/generate/talking.md - Summarize a podcast or an article (you assemble it): You write the summary. Your mascot reads it out. Guide: https://masko.ai/docs/generate/talking.md - Explain your numbers in a video (you assemble it): You bring the numbers. Your mascot presents them. Guide: https://masko.ai/docs/generate/talking.md - Host a YouTube series with your character (you assemble it): Masko makes each talking scene. You edit the episodes. Guide: https://masko.ai/docs/generate/talking.md ### Brand - Create a mascot that matches your logo and colors (works today): Start from text, your logo, your website or a brand book. Tutorial: https://masko.ai/docs/tutorials/first-mascot.md - Animate the mascot you already have (works today): Upload your character and animate that exact image. Tutorial: https://masko.ai/docs/tutorials/animate-your-mascot.md - Build a library of poses and expressions (works today): Poses and expressions of one character, in one place. Guide: https://masko.ai/docs/generate/images.md - Turn your pet, or yourself, into an illustrated character (works today): From a photo to an illustrated character you can animate. Guide: https://masko.ai/docs/create/from-image.md - Make a logo or app icon from your mascot (works today): Logos and app icons from your mascot, SVG when you need it. Guide: https://masko.ai/docs/generate/design-assets.md - Make stickers for WhatsApp, Telegram and Discord (works today): Image and animated stickers, with a Telegram pack ready. Tutorial: https://masko.ai/docs/tutorials/telegram-stickers.md - Make backgrounds for your app and site (works today): A place in your mascot’s style, where its animation plays. Guide: https://masko.ai/docs/generate/design-assets.md - Dress your mascot for seasons or campaigns (works today): Outfit variants: chef, rain gear, space suit. Guide: https://masko.ai/docs/manage/collections.md - Make mascots for your agency’s clients (works today): A project per client, with its own mascots and files. Guide: https://masko.ai/docs/how-mascots-work.md - Sell your mascot on the marketplace (works today): Submit it to the Masko marketplace for others to get. Guide: https://masko.ai/docs/manage/collections.md#publish-to-the-marketplace ## Tutorials Step-by-step guides that show the finished result first, then each step in Studio and with the REST API, with the credits before you spend them. Times are estimates. New to Masko? Follow the four Start here tutorials in order. All tutorials: https://masko.ai/docs/tutorials - [Create your first mascot](https://masko.ai/docs/tutorials/first-mascot.md): Start here, step 1. Describe a character in one sentence and get your first Masko mascot, in Studio or with the REST API. About 5 minutes and 1 credit. - [How to create an animated character](https://masko.ai/docs/tutorials/first-animation.md): Start here, step 2. Create an animated character step by step: make the character, then its first transparent five-second loop, in Studio or with the REST API. About 12 credits. (About 15 min, 12 credits) - [Lip sync animation: how to make a character talk](https://masko.ai/docs/tutorials/make-it-talk.md): Start here, step 3. How to lip sync an animation without drawing mouth shapes: give your character a voice, write a line, and get a transparent talking video with sound. (About 15 min, 13 credits) - [Put your mascot on your website](https://masko.ai/docs/tutorials/mascot-on-your-website.md): Start here, step 4. Play a transparent mascot animation on any web page with the Masko player, in plain HTML or React, using its hosted links. About 5 minutes and no credits. - [Guide onboarding with a talking mascot](https://masko.ai/docs/tutorials/web-onboarding-mascot.md): Build the Fold web demo with Nori: create the assets, connect real interactions, and download the complete React source. (About 45 min, from 42 credits) - [Add a mascot that celebrates progress and welcomes users back](https://masko.ai/docs/tutorials/web-progress-companion.md): Build the Little Wins web demo with Pip: create the assets, connect real interactions, and download the complete React source. (About 35 min, from 21 credits) - [Add a talking support mascot in the bottom right](https://masko.ai/docs/tutorials/web-support-mascot.md): Build the Leaf & Loom web demo with Fern: create the assets, connect real interactions, and download the complete React source. (About 35 min, from 42 credits) - [Show a mascot while your AI thinks](https://masko.ai/docs/tutorials/ai-loading-mascot.md): Make a thinking loop, a waiting loop and a celebration, then switch between them without a flicker while an AI request runs. About 33 credits. (About 25 min, 33 credits) - [Give your AI agent a face](https://masko.ai/docs/tutorials/ai-agent-face.md): Show what your AI agent is doing with your mascot: thinking, searching, needs approval, done or error, driven by Claude Code and Codex hooks. (About 20 min, 66 credits) - [Animate the mascot you already have](https://masko.ai/docs/tutorials/animate-your-mascot.md): Upload your character as a PNG, logo or drawing and get a five-second transparent loop that keeps its look, in Studio or with one REST call. (About 10 min, 10 credits) - [How to make Telegram stickers](https://masko.ai/docs/tutorials/telegram-stickers.md): Make Telegram stickers of your own character, image and animated, and add them as one pack from a QR code. No bot, no file conversion, no Telegram setup. (About 20 min, from 1 credit) - [How to make Discord stickers](https://masko.ai/docs/tutorials/discord-stickers.md): Make Discord stickers of your own character, animated and image, in the 320 by 320 format Discord asks for, then upload them to your server. (About 20 min, from 1 credit) ## Products and website ### Masko Studio - [Masko Studio](https://masko.ai/studio): The web studio for mascot images, animations, logos, backgrounds, stickers and interactive canvases. Start from a description, website or existing artwork. - [App mascot examples](https://masko.ai/studio/app-mascots): Explore how mascots support apps and websites, then create your own character with Masko Studio. - [Mascot guide](https://masko.ai/mascot-101): Introduction to mascots and their uses. - [Masko Studio for devices](https://masko.ai/studio/devices): ESP32 character animation - [Muse Gadgets alternative](https://masko.ai/studio/devices/muse-gadgets): Muse Gadgets alternative - [Masko Studio API](https://masko.ai/studio/api): mascot generation API - [Masko guides](https://masko.ai/guides): mascot guides - [How to Animate a Mascot from an Image](https://masko.ai/guides/how-to-animate-a-mascot): Learn how to animate an existing mascot in Masko Studio or through the API: upload your image, describe the movement, and export a transparent video for your app. - [How to Make an AI Explainer Video with a Talking Mascot](https://masko.ai/guides/how-to-make-an-ai-explainer-video): Make an AI explainer video with your own talking mascot as presenter. Pick a voice, direct its gestures, and place it over your visuals. Full example included. - [Fitness app mascots](https://masko.ai/studio/app-mascots/fitness): fitness app mascot - [Learning app mascots](https://masko.ai/studio/app-mascots/learning): learning app mascot - [Meditation app mascots](https://masko.ai/studio/app-mascots/meditation): meditation app mascot - [Savings app mascots](https://masko.ai/studio/app-mascots/savings): savings app mascot - [Cooking app mascots](https://masko.ai/studio/app-mascots/cooking): cooking app mascot - [Reading app mascots](https://masko.ai/studio/app-mascots/reading): reading app mascot - [Sleep app mascots](https://masko.ai/studio/app-mascots/sleep): sleep app mascot - [Gardening app mascots](https://masko.ai/studio/app-mascots/gardening): gardening app mascot - [Focus app mascots](https://masko.ai/studio/app-mascots/focus): focus app mascot - [Travel app mascots](https://masko.ai/studio/app-mascots/travel): travel app mascot - [Company mascots](https://masko.ai/studio/company-mascot): company mascot generator - [Brand book to mascot](https://masko.ai/studio/brand-book): mascot brand book - [Cursor follower](https://masko.ai/studio/cursor-follower): cursor follower - [AI agent mascots](https://masko.ai/studio/ai-agent-mascot): AI agent mascot generator - [Animation](https://masko.ai/studio/animation): Create an animated character from one picture. The AI animated character generator makes loops, reactions and animated mascots as transparent video. - [Talking characters](https://masko.ai/studio/talking): Make a talking cartoon of your mascot: give it a character voice, write the line, and get a talking animation with AI lip sync on a transparent background. - [Stickers](https://masko.ai/studio/stickers): Make image and animated stickers of your own character. Animated Discord stickers come as 320 by 320 APNG; Telegram gets a full pack from one QR code. - [Logos](https://masko.ai/studio/logos): Turn your mascot into a custom logo. Explore graphic styles, download app icons and favicons, and generate an editable SVG with Masko Studio. - [Mascot state machine](https://masko.ai/studio/mascot-state-machine): Build a mascot state machine. Connect your mascot's poses, let Masko generate every transition, and let your app decide how your mascot reacts. ### Masko for Mac - [Masko for Mac](https://masko.ai/desktop): A desktop companion for macOS 14 or newer. Start free with Ko, choose or create a mascot, and connect it to supported AI agents. Integration capabilities vary by agent; see the integration guides. - [Developers: the masko command and SDKs](https://masko.ai/studio/desktop): Make and download mascots from the terminal, scripts, Swift, Node.js or Electron with the masko command, signed in with your browser. Requires an Apple Silicon Mac with macOS 14 or newer. It does not show mascots on screen: Masko for Mac does. - [Download Masko for Mac](https://masko.ai/download): Mac download and installation information. - [Companions](https://masko.ai/companions): Choose an AI desktop companion or playful desktop pet for Mac. Start with Ko, find a finished character, or create a mascot that reacts to your work. - [AI desktop companion](https://masko.ai/companions/ai-desktop-companion): Meet an AI desktop companion that lives beside your work on Mac, shows when supported AI agents need you, and performs useful companion apps. - [Desktop pet for Mac](https://masko.ai/companions/desktop-pet-for-mac): Get an interactive desktop pet for Mac that rests, reacts, reminds you, and follows AI-agent activity. Start free with Ko or create your own. - [Integrations](https://masko.ai/integrations): Connect Claude Code, Codex, Cursor, Grok Build, Kimi Code, and Hermes Agent to one Masko desktop mascot with visible status on Mac. - [Claude Code](https://masko.ai/integrations/claude-code): Claude Code’s own mascot is Clawd. Masko gives Claude Code your own animated mascot on your Mac that shows when it works, asks, or finishes. - [Codex](https://masko.ai/integrations/codex): Give Codex a custom desktop pet on Mac. See working, waiting, approvals, completion, errors, and subagent activity, then return to Codex when needed. - [Cursor](https://masko.ai/integrations/cursor): Connect Cursor hooks to a Masko desktop pet on Mac. See agent sessions, tool use, and file edits, then return to the native Cursor agent prompt. - [Grok Build](https://masko.ai/integrations/grok-build): Connect Grok Build to a Masko desktop pet on Mac. See agent activity, questions, completion, and errors, with supported responses and native handoff. - [Kimi Code](https://masko.ai/integrations/kimi-code): Connect Kimi Code to a Masko desktop pet on Mac. See working, questions, completion, and errors, then return to the native Kimi Code prompt. - [Hermes Agent](https://masko.ai/integrations/hermes-agent): Connect Hermes Agent to a Masko desktop pet on Mac. See agent activity, clarification questions, completion, errors, and supported response paths. - [Features](https://masko.ai/features): See AI agent notifications, permission requests, supported approvals, and terminal return through one animated Masko desktop mascot on your Mac. - [AI agent notifications](https://masko.ai/features/ai-agent-notifications): Get visible AI agent notifications for working, waiting, questions, completion, interruption, and errors through an animated Masko mascot on Mac. - [Permissions and approvals](https://masko.ai/features/permissions-and-approvals): See AI agent permission requests through a Masko desktop mascot, answer directly where supported, or return safely to the exact native prompt. - [Terminal focus](https://masko.ai/features/terminal-focus): Use a Masko desktop mascot notification to return to the exact terminal, tab, or agent surface that needs your response without hunting for it. - [Apps](https://masko.ai/apps): Give your Masko desktop companion useful apps for focus, breaks, breathing, water, music reactions, and Mac system health through one character. ### Masko Life - [Masko Life](https://masko.ai/life): Raise a little companion, feed it, share photos and keep memories as it grows. See the product page for current Android and iOS availability. - [Masko Life privacy](https://masko.ai/life/privacy): Privacy policy for Masko Life. - [Masko Life terms](https://masko.ai/life/terms): Terms for Masko Life. - [Masko Life account deletion](https://masko.ai/life/delete-account): How to request account deletion. ### Marketplace and general information - [Masko](https://masko.ai/): Create mascots from text or reference artwork, generate consistent poses and transparent animations, and use the assets in apps, agents and websites. - [Marketplace](https://masko.ai/marketplace): Sign in to browse mascot listings. Check each listing for included assets, licensing, price and compatible uses; Studio libraries and existing Desktop playable purchases have different content. - [Affiliate program](https://masko.ai/affiliates): Masko affiliate information. - [Free mascot tools](https://masko.ai/tools): free mascot tools - [Discord sticker and emoji maker](https://masko.ai/tools/discord-emoji-maker): discord emoji maker - [Telegram sticker maker](https://masko.ai/tools/telegram-sticker-maker): telegram sticker maker - [WhatsApp sticker maker](https://masko.ai/tools/whatsapp-sticker-maker): whatsapp sticker maker - [Slack emoji maker](https://masko.ai/tools/slack-emoji-maker): slack emoji maker - [Twitch emote maker](https://masko.ai/tools/twitch-emote-maker): twitch emote maker - [Transparent GIF maker](https://masko.ai/tools/transparent-gif-maker): transparent gif maker - [Sprite sheet generator](https://masko.ai/tools/sprite-sheet-generator): sprite sheet generator - [Video file size calculator](https://masko.ai/tools/video-file-size-calculator): video file size calculator - [Character expression sheet](https://masko.ai/tools/character-expression-sheet): character expression sheet - [Mascot name generator](https://masko.ai/tools/mascot-name-generator): mascot name generator - [Brand archetype quiz](https://masko.ai/tools/brand-archetype-quiz): brand archetype quiz - [Virtual pet: Dumple](https://masko.ai/tools/virtual-pet): virtual pet online ## Pricing, licensing and support - [Credits and generation costs](https://masko.ai/docs/credits.md): Current generation rates, balance, estimates and failure handling. Studio and API generation use credits; some Desktop interfaces call them Masks. - [Terms](https://masko.ai/terms): Terms for generated outputs, source material and commercial use. Marketplace listings specify their available licenses. - [Privacy](https://masko.ai/privacy): Masko privacy policy. - [Support](mailto:paul@masko.ai): Product, account and billing questions. ## Studio REST API v1 and programmatic access The REST API lets applications and AI agents create and manage mascots, assets and canvases. Masko for Mac agent integrations connect agent activity to the Mac companion; see the Masko for Mac section above. - Production base URL: https://api.masko.ai/v1. Documented operation paths already include /v1; do not add it twice. - Protected requests use Authorization: Bearer . Keep secret credentials on your server or in your local environment. - [MCP server](https://masko.ai/docs/mcp.md): https://masko.ai/api/mcp exposes mascot, animation, canvas and job tools. Claude Code, Codex and VS Code connect with an API key in the Authorization header; Claude, ChatGPT and Cursor sign in with OAuth. Voices and talking use the REST API. - Current canonical contract: 2026-09-26. Use /v1/mascots and /v1/canvases. Send Masko-API-Version: 2026-09-26 for canonical fields on shared paths such as jobs and assets. Legacy /v1/collections routes remain compatible and deprecated. - Read each operation's schema, review generation costs, retain returned IDs and follow the accepted job's poll_url. Use Idempotency-Key on supported POST requests for safe retries. - [OpenAPI specification](https://api.masko.ai/v1/openapi.json): Authoritative deployed paths, request fields, response schemas and API version. Check this for rollout availability. - [Documentation query](https://api.masko.ai/v1/docs): Public text index; use ?q=animation to search or ?slug=generate/animations for a complete guide. Documentation and OpenAPI require no authentication. - [Full documentation](https://masko.ai/llms-full.txt): Product overview, all public guides and an operation index generated from OpenAPI. - [Feedback](https://masko.ai/docs/ai-agents.md#send-feedback-to-masko): When something in Masko is confusing, broken or missing, or works well, tell the Masko team with POST /v1/feedback or the MCP tool send_feedback, then carry on with the task. Only summary is required, read-only keys work, and each account can send 5 a minute and 30 a day. This index is generated from the documentation and public website page registry shipped with this deployment. Documentation changes appear after deployment; these text endpoints may be cached for one hour. This is not a live catalog of marketplace inventory, account balances or subscription offers. ## Documentation ### Use cases - [Overview](https://masko.ai/docs/use-cases): Everything you can do with a Masko mascot, by platform, with each result playing and its status. ### Build with your AI agent - [Build with your AI agent: Claude Code, Codex, Cursor](https://masko.ai/docs/ai-agents.md): Your coding agent can create your mascot, animate it and put it in your app. Give it a Masko API key and the MCP server, then ask in plain words. - [Masko MCP server: Claude Code, Codex, Cursor, Claude](https://masko.ai/docs/mcp.md): Connect Claude Code, Codex, Cursor, Claude, ChatGPT or VS Code to Masko's MCP server, then create, animate and ship mascots from a chat. - [Masko for Cursor: mascots in your code editor](https://masko.ai/docs/ai-tools/cursor.md): Create mascots, animate your own artwork, and integrate transparent animations into your app with Masko's Cursor plugin. - [Masko in ChatGPT: create and animate mascots](https://masko.ai/docs/ai-tools/chatgpt.md): Connect your Masko account to create mascots, animate uploaded characters, build interactive canvases, and integrate completed assets into your app. ### Tutorials - [All tutorials](https://masko.ai/docs/tutorials): Every tutorial by platform: the four Start here steps, the ones that are written and the ones coming soon. - [Create your first mascot](https://masko.ai/docs/tutorials/first-mascot.md): Describe a character in one sentence and get your first Masko mascot, in Studio or with the REST API. About 5 minutes and 1 credit. - [How to create an animated character](https://masko.ai/docs/tutorials/first-animation.md): Create an animated character step by step: make the character, then its first transparent five-second loop, in Studio or with the REST API. About 12 credits. - [Lip sync animation: how to make a character talk](https://masko.ai/docs/tutorials/make-it-talk.md): How to lip sync an animation without drawing mouth shapes: give your character a voice, write a line, and get a transparent talking video with sound. - [Put your mascot on your website](https://masko.ai/docs/tutorials/mascot-on-your-website.md): Play a transparent mascot animation on any web page with the Masko player, in plain HTML or React, using its hosted links. About 5 minutes and no credits. - [Guide onboarding with a talking mascot](https://masko.ai/docs/tutorials/web-onboarding-mascot.md): Build the Fold web demo with Nori: create the assets, connect real interactions, and download the complete React source. - [Add a mascot that celebrates progress and welcomes users back](https://masko.ai/docs/tutorials/web-progress-companion.md): Build the Little Wins web demo with Pip: create the assets, connect real interactions, and download the complete React source. - [Add a talking support mascot in the bottom right](https://masko.ai/docs/tutorials/web-support-mascot.md): Build the Leaf & Loom web demo with Fern: create the assets, connect real interactions, and download the complete React source. - [Show a mascot while your AI thinks](https://masko.ai/docs/tutorials/ai-loading-mascot.md): Make a thinking loop, a waiting loop and a celebration, then switch between them without a flicker while an AI request runs. About 33 credits. - [Give your AI agent a face](https://masko.ai/docs/tutorials/ai-agent-face.md): Show what your AI agent is doing with your mascot: thinking, searching, needs approval, done or error, driven by Claude Code and Codex hooks. - [Animate the mascot you already have](https://masko.ai/docs/tutorials/animate-your-mascot.md): Upload your character as a PNG, logo or drawing and get a five-second transparent loop that keeps its look, in Studio or with one REST call. - [How to make Telegram stickers](https://masko.ai/docs/tutorials/telegram-stickers.md): Make Telegram stickers of your own character, image and animated, and add them as one pack from a QR code. No bot, no file conversion, no Telegram setup. - [How to make Discord stickers](https://masko.ai/docs/tutorials/discord-stickers.md): Make Discord stickers of your own character, animated and image, in the 320 by 320 format Discord asks for, then upload them to your server. ### Start - [API quickstart: your first mascot animation](https://masko.ai/docs/quickstart.md): Create a mascot and get a five-second transparent animation of it waving, hosted and ready for your app or website, with four REST calls and 12 credits. - [Masko terminal quickstart](https://masko.ai/docs/terminal.md): Install the masko command, sign in with your browser, then make, animate and download mascots with the Masko API from your terminal or scripts. - [API keys and workspaces](https://masko.ai/docs/authentication.md): Create a Masko API key, authenticate REST requests, and choose the workspace that owns your resources and credits. - [Masko CLI login: browser and device sign-in](https://masko.ai/docs/authentication/cli.md): Connect the Masko CLI through browser approval or device login, select a workspace, and manage sessions. - [How mascots work: the Masko data model](https://masko.ai/docs/how-mascots-work.md): The Masko data model. Projects own mascots and canvases, mascots hold items and assets, and every generated file links back to the file it came from. - [Credits and generation costs](https://masko.ai/docs/credits.md): What each generation costs in credits, how to estimate work before paying, check your balance, buy credits, and handle partial failures. ### Create - [Create a mascot from text](https://masko.ai/docs/create/from-text.md): Describe your character in natural language, pick a style preset, and generate a mascot via API. Browse available presets from the styles endpoint. - [Create a mascot from an image](https://masko.ai/docs/create/from-image.md): Upload your character as a reference image. AI vision extracts a prompt that keeps future generations on model. Up to 6 references. - [Create a mascot from a website](https://masko.ai/docs/create/from-website.md): Analyze any website URL to extract page metadata, brand context, and optional mascot suggestions that can seed a text-to-mascot flow. - [Create a mascot from a brand book](https://masko.ai/docs/create/from-brand-book.md): Turn a brand book PDF or its page images into a ready mascot in one API call, with every view as a reference and its colors, style, don'ts and props filled in. - [Reference images and style consistency](https://masko.ai/docs/manage/references.md): The three kinds of reference images in the Masko API: mascot references that persist, preview hints that do not, and the source assets you animate. ### Make it move - [What you can generate and what it costs](https://masko.ai/docs/generation.md): Every asset Masko generates from a mascot, with its guide and cost: images, animations, talking animations, logos, SVGs, backgrounds and stickers. - [Pose-to-animation walkthrough](https://masko.ai/docs/generate/workflow.md): Create a mascot with reference images, generate a pose, check it, then animate that exact pose. Every REST call with its response. - [Mascot images and poses](https://masko.ai/docs/generate/images.md): Generate mascot pose images and transparent PNGs, edit existing poses, and keep the style consistent across your mascot. 1 credit per image. - [Mascot animation API: loops and transitions](https://masko.ai/docs/generate/animations.md): Generate transparent mascot animations as WebM, HEVC with alpha and MP4: loops, transitions and motion from a video. Standard costs 2 credits a second. - [Talking mascot animations with voice](https://masko.ai/docs/generate/talking.md): Give your mascot a voice and generate transparent talking animations with sound, a timed transcript and captions. 2 credits per second. - [Logos, backgrounds and stickers](https://masko.ai/docs/generate/design-assets.md): Turn an existing mascot into a logo or app icon, an editable SVG, a background for your app, or a sticker with a white border. - [Cursor follower: a mascot that follows the mouse](https://masko.ai/docs/generate/cursor-follower.md): Turn one transparent mascot image into nine gaze directions so your mascot follows the cursor on a website. 9 credits, made in Studio or with the API. - [Batch generation and AI suggestions](https://masko.ai/docs/generate/batch.md): Generate multiple mascot images and animations in a single request. AI-powered action suggestions for poses. Parallel processing with individual job tracking. - [Image and video exports](https://masko.ai/docs/manage/media-exports.md): Resize mascot images and export animations through the app or v1 API, with saved mascot settings and project or folder bulk actions. ### State machine - [Canvases: mascot state machines and releases](https://masko.ai/docs/canvas.md): Create a canvas, the state machine that decides how your mascot reacts, edit its graph safely, generate its media, save checkpoints and ship playable releases. - [Build a canvas: nodes, edges and inputs](https://masko.ai/docs/canvas/build.md): Build a mascot canvas: nodes for poses, edges for transitions, conditions on inputs, and full graph replacement with PATCH. - [Canvas templates: start from a ready graph](https://masko.ai/docs/canvas/templates.md): Start a canvas from a ready-made graph of poses, transitions and inputs. List built-in and saved templates, apply one to a new canvas, and save your own. - [Generate canvas assets](https://masko.ai/docs/canvas/generate-all.md): Generate pending node images and transition videos for a canvas with one API call. Includes explicit generated, skipped, reverse-free, and cost accounting. - [Export a canvas graph as JSON](https://masko.ai/docs/canvas/export.md): Read a completed canvas as JSON, with its nodes, edges, inputs and media URLs, or as a runtime delivery envelope. Apps play a release with the Masko player. ### Masko player - [Masko player: play your mascot on the web, iPhone, Mac, React Native, Flutter and Android](https://masko.ai/docs/player.md): The Masko player is the open-source player for Masko mascots. Install it with npm, Swift Package Manager, pub.dev or Maven Central, loop one animation, or play a canvas that reacts to your app with set and fire. - [Play one animation with the Masko player](https://masko.ai/docs/player/one-animation.md): Loop one transparent Masko animation in a website or an app with the Masko player, from its hosted WebM and HEVC files, with no backend and no API key. - [Play a canvas with the Masko player](https://masko.ai/docs/player/canvas.md): Play a released Masko canvas in your website or app with the Masko player. Your backend fetches the release delivery, the player runs every canvas rule, and your app drives it with set and fire. - [Mascot hosting, CDN and file formats](https://masko.ai/docs/generate/cdn.md): Which file to play on each platform, how to put a transparent animation on a web page, and how hosted CDN URLs and size variants work. - [Mascot animation file sizes](https://masko.ai/docs/generate/file-sizes.md): How heavy mascot animations are on a website, iPhone or Android: WebM, HEVC, stacked MP4 and stacked AV1 sizes, with a calculator for your own clips. - [Float a mascot on your Mac](https://masko.ai/docs/integrations/desktop.md): How Masko Desktop floats a mascot above your windows, how to install one from the marketplace, and what the API controls. ### Track - [Job polling API: track each generation](https://masko.ai/docs/manage/jobs.md): Track generation jobs with polling or long-polling, check a job's status, and get asset URLs when it completes. Webhooks are the alternative. - [Webhooks: job events, signatures and retries](https://masko.ai/docs/manage/webhooks.md): Get notified when Masko jobs complete or fail: timestamped HMAC-SHA256 signatures, stable event IDs for deduplication, retries over about 21 hours. - [Manage mascots and assets](https://masko.ai/docs/manage/collections.md): List projects, mascots, items and assets, export hosted links, create variants, and publish a mascot to the Marketplace with the REST API. ### Reference - [All endpoints](https://masko.ai/docs/reference): Every REST endpoint with its request fields and responses, generated from OpenAPI. - [Requests and responses](https://masko.ai/docs/reference/conventions.md): Base URLs, JSON envelopes, pagination, async generation receipts, and safe retries shared by the Masko REST API. - [Masko API error codes and recovery](https://masko.ai/docs/reference/errors.md): Complete reference for API error codes. Covers 400, 401, 402, 403, 404, 409, 429, and 500 errors with explanations, common causes, and recovery strategies. - [Command line reference](https://masko.ai/docs/terminal/commands.md): Every masko command and option, its output and exit codes: sign in, check credits, call the Masko API, retry safely, upload and download files. - [TypeScript SDK](https://masko.ai/docs/sdk/typescript.md): Call the Masko API from Node.js or Electron main on macOS with your saved Masko login, with pagination, safe retries and the API's error fields. - [Masko API changelog: every v1 update](https://masko.ai/docs/reference/changelog.md): Every update to the Masko v1 API with release dates, breaking changes, new endpoints, and migration notes for each version. - [Migrate to mascots and canvases](https://masko.ai/docs/manage/studio-migration.md): Move an integration from /v1/collections to /v1/mascots and /v1/canvases, keep current field names on shared routes, and set the animation price explicitly. ### Additional guides - [Masko in Lovable: add animated mascots to your app](https://masko.ai/docs/ai-tools/lovable.md): Connect Lovable to Masko with an API key, create a mascot and its animations from a chat, and use the finished files in your app. - [Masko for Muse: integration guide](https://masko.ai/docs/ai-tools/muse.md): Masko's Muse integration guide for creating mascots, animating your own artwork, building interactive canvases, and integrating assets into apps and websites. - [Masko skill for coding agents: setup and prompts](https://masko.ai/docs/ai-tools/skills.md): Use Masko from Claude Code, Cursor, Copilot, Codex, Gemini, Windsurf and other coding agents with an API key and a plain prompt. - [Guide onboarding with a talking mascot](https://masko.ai/docs/use-cases/web-onboarding.md): Build Fold with Nori: reference prompts, state flow, Masko v1 requests and copyable React integration. - [Add a mascot that celebrates progress and welcomes users back](https://masko.ai/docs/use-cases/web-progress-companion.md): Build Little Wins with Pip: reference prompts, state flow, Masko v1 requests and copyable React integration. - [Add a talking support mascot in the bottom right](https://masko.ai/docs/use-cases/web-support-mascot.md): Build Leaf & Loom with Fern: reference prompts, state flow, Masko v1 requests and copyable React integration.