# 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 Desktop. Masko Life is the companion you raise and care for. ## Products and website ### Masko Studio - [Masko Studio](https://masko.ai/studio): The web studio for mascot images, animations, logos, scenes, 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 guides](https://masko.ai/guides): mascot guides - [How to Animate a Mascot from an Image](https://masko.ai/guides/how-to-animate-a-mascot): how to animate a mascot - [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 - [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): Animate your mascot from a reference image. Create expressive loops, reactions, and transparent WebM and HEVC videos for your app or website. - [Talking characters](https://masko.ai/studio/talking): Make your mascot or character talk in its own voice. Write the line, add its moves in brackets, and get a talking animation with a transparent background. - [Stickers](https://masko.ai/studio/stickers): Turn your character into transparent AI stickers. Create expressive poses, keep a shared character reference, and download sticker images with Masko Studio. - [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 Desktop - [Masko Desktop](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: Mac runtime, CLI and SDKs](https://masko.ai/studio/desktop): Control a native floating mascot from the terminal, Swift, TypeScript or Electron. The desktop runtime requires macOS; Studio and the REST API create assets for apps and websites. - [Download Masko Desktop](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, Claude Cowork, 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): Connect Claude Code to a Masko desktop mascot on Mac. See working, permissions, questions, completion, and errors, then respond where supported. - [Claude Cowork](https://masko.ai/integrations/claude-cowork): Connect Claude Cowork to a Masko desktop pet on Mac. See task activity, questions, completion, and supported interactions through your mascot. - [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. ## Pricing, licensing and support - [Credits and generation costs](https://masko.ai/docs/credits): 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 Desktop agent integrations connect agent activity to the Mac companion; see the Desktop section above. - Production base URL: https://api.masko.ai/v1. Documented operation paths already include /v1; do not add it twice. - Local Next.js base URL: http://localhost:3000/api/v1. - Protected requests use Authorization: Bearer . Keep secret credentials on your server or in your local environment. - 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. 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 ### Start here - [API overview](https://masko.ai/docs): Public documentation page. - [REST quickstart | Masko](https://masko.ai/docs/quickstart): Create a mascot, generate an animation, poll its job, and retrieve hosted assets with the Masko REST API. - [API Keys and Workspaces | Masko API](https://masko.ai/docs/authentication): Create a Masko API key, authenticate REST requests, and choose the workspace that owns your resources and credits. - [How Mascots Work - Data Model & Asset Pipeline | Masko API](https://masko.ai/docs/how-mascots-work): Understand the Masko data model. Projects own mascots and independent canvases. Mascots contain items and assets. Learn the generation graph and asset hierarchy. - [Requests and Responses | Masko API](https://masko.ai/docs/reference/conventions): Base URLs, JSON envelopes, pagination, async generation receipts, and safe retries shared by the Masko REST API. - [Mascots, canvases and legacy v1](https://masko.ai/docs/manage/studio-migration): Move collection integrations to canonical mascot and independent canvas routes while preserving existing IDs and credentials. - [Generation credits | Masko](https://masko.ai/docs/credits): Check generation costs and balance, estimate work before paying, and understand partial failures and media repair. ### Create a mascot - [Create Mascot from Text Description - Style & Prompt API](https://masko.ai/docs/create/from-text): Describe your character in natural language, pick a style preset, and generate a mascot via API. Browse available presets from the styles endpoint. - [Create Mascot from Image Upload - Reference Analysis API](https://masko.ai/docs/create/from-image): Upload your existing character design as a reference image. AI vision analyzes the image and extracts a prompt for consistent future generations. Up to 6 references. - [Create Mascot from Website URL - Brand Analysis API | Masko](https://masko.ai/docs/create/from-website): Analyze any website URL to extract page metadata, brand context, and optional mascot suggestions that can seed a text-to-mascot flow. - [Reference Images & Style Consistency | Masko API](https://masko.ai/docs/manage/references): Understand the three kinds of reference images in the Masko API. Mascot references persist across generations. Preview hints are ephemeral. Source assets are what you animate. ### Generate assets - [Generation API | Masko](https://masko.ai/docs/generation): Choose an image, animation, edit, logo, or scene workflow with the Masko REST API. - [End-to-End Generation Flow | Masko API](https://masko.ai/docs/generate/workflow): Complete flow to animate a mascot via the Masko API. Create a mascot, add reference images, generate a pose, animate it. REST and curl examples. - [Generate Mascot Images & Transparent PNGs via API | Masko](https://masko.ai/docs/generate/images): Generate AI mascot images, edit existing poses, and get transparent PNGs via REST API. Style consistency across your mascot. 1 credit per image. - [Transparent Animation API - Generate WebM, HEVC & MP4 Video](https://masko.ai/docs/generate/animations): Generate transparent mascot animations via API. Get WebM, HEVC with alpha, and MP4 output. Auto-reverse transitions, size variants, and instant CDN URLs. Standard at 2 credits/sec or Premium at 6 credits/sec. - [Talking Mascot API - Make Your Mascot Say a Line in Its Voice](https://masko.ai/docs/generate/talking): Give your mascot a voice and generate transparent talking animations with sound, a timed transcript and captions. 3 credits per second of video. - [Logos, scenes and stickers | Masko API](https://masko.ai/docs/generate/design-assets): Create a logo or scene from an existing mascot, and generate a sticker from an image asset. - [Batch Generate Mascot Assets - Multiple Items in One API Call](https://masko.ai/docs/generate/batch): Generate multiple mascot images and animations in a single request. AI-powered action suggestions for poses. Parallel processing with individual job tracking. ### Track & deliver - [Masko Jobs & Polling - Track Generation Progress via API](https://masko.ai/docs/manage/jobs): Monitor generation jobs with polling or long-polling. List recent jobs, check individual status, and get asset URLs on completion. Supports webhooks as alternative. - [Masko Webhooks - HMAC-Signed Job Notifications](https://masko.ai/docs/manage/webhooks): Receive real-time notifications when jobs complete or fail. Timestamped HMAC-SHA256 signatures, stable event IDs for deduplication, retries over about 21 hours, and delivery management. - [Image and Video Exports](https://masko.ai/docs/manage/media-exports): Resize mascot images and export animations through the app or v1 API, with saved mascot settings and project or folder bulk actions. - [Instant CDN URLs for Generated Assets - Pre-Allocated Placeholders](https://masko.ai/docs/generate/cdn): Get permanent CDN URLs immediately when you trigger generation. Placeholder assets are served until the real file is ready. Supports size variants and custom slugs. - [Smooth mascot playback without flicker](https://masko.ai/docs/integrations/playback): Build direct HTML, React, Swift or Android playback with two persistent players, verified first frames and safe transitions between mascot clips. - [Masko API - List Projects, Mascots, Items & Assets](https://masko.ai/docs/manage/collections): Browse and filter your mascot data via API. List projects, mascots with pagination, items with assets, and CDN URLs. Supports search and status filtering. ### Canvas - [Masko Canvas API - Independent Canvases and Releases](https://masko.ai/docs/canvas): Create a project-owned canvas, edit its graph safely, generate media, and preserve checkpoints or playable releases. - [Masko Canvas - Build Interactive Mascot State Machines](https://masko.ai/docs/canvas/build): Create interactive canvases with nodes for poses, edges for transitions, conditions for logic, and resolved behavior inputs. Full graph replacement via PATCH endpoint. - [Masko Canvas Templates - Prebuilt State Machine Presets](https://masko.ai/docs/canvas/templates): Apply built-in and compatibility templates to quickly scaffold a canvas. List, preview, and customize templates via API. - [Masko Canvas Generate All - Batch Generate Canvas Assets](https://masko.ai/docs/canvas/generate-all): Generate pending node images and transition videos for a canvas with one API call. Includes explicit generated, skipped, reverse-free, and cost accounting. - [Masko Canvas Export - MaskoAnimationConfig JSON Output](https://masko.ai/docs/canvas/export): Export a completed canvas as a MaskoAnimationConfig JSON object. Includes nodes, edges, asset URLs, and transition metadata for web and desktop rendering. ### API reference - [All endpoints](https://masko.ai/docs/reference): Public documentation page. - [Masko API Error Codes - Troubleshooting & Recovery Guide](https://masko.ai/docs/reference/errors): Complete reference for API error codes. Covers 400, 401, 402, 403, 404, 409, 429, and 500 errors with explanations, common causes, and recovery strategies. - [API Changelog - Version History and Updates](https://masko.ai/docs/reference/changelog): Every update to the Masko v1 API with release dates, breaking changes, new endpoints, and migration notes for each version. ### Desktop & SDKs - [Terminal quickstart | Masko](https://masko.ai/docs/terminal): Install Masko on macOS, show Ko on your desktop, and control its states and reactions from the terminal. - [CLI Browser Login | Masko API](https://masko.ai/docs/authentication/cli): Connect the Masko CLI through browser approval or device login, select a workspace, and manage sessions. - [Desktop commands | Masko CLI](https://masko.ai/docs/terminal/commands): Show, control, inspect and close native desktop mascots. Understand state, play, completion, names and diagnostics. - [Create mascots and canvases](https://masko.ai/docs/terminal/create): REST authoring during the Studio migration. - [Migrating developer characters](https://masko.ai/docs/manage/developer-characters): Replace the retired developer character registry with mascot and canvas resources. - [Swift SDK | Masko](https://masko.ai/docs/sdk/swift): Control a floating desktop mascot from your macOS app with the Masko Swift package. Show, state, play and dispose a hosted character. - [TypeScript and Electron SDK | Masko](https://masko.ai/docs/sdk/typescript): Control native desktop mascots from Electron main or Node.js using the Masko TypeScript SDK and bundled macOS renderer. - [Backend mascot integration](https://masko.ai/docs/sdk/application-access): Integrate mascot generation and immutable canvas releases through your backend. ### AI agents - [AI Agent Integration with the Masko API](https://masko.ai/docs/ai-agents): Use Masko from any AI coding agent through the public REST API, OpenAPI specification, and reusable AI skill. - [Connect Masko to ChatGPT](https://masko.ai/docs/ai-tools/chatgpt): Connect your Masko account to create mascots, animate uploaded characters, build interactive canvases, and integrate completed assets into your app. - [Masko for Muse](https://masko.ai/docs/ai-tools/muse): Masko's Muse integration guide for creating mascots, animating your own artwork, building interactive canvases, and integrating assets into apps and websites. - [Masko AI Skills for Coding Agents](https://masko.ai/docs/ai-tools/skills): Install Masko instructions in Claude Code, Cursor, Copilot, Codex, Gemini, Windsurf, and other coding agents.