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 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
  • 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
  • Smooth mascot playback/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
  • Desktop commands/docs/terminal/commands
  • CLI browser login/docs/authentication/cli
  • Swift SDK/docs/sdk/swift
  • TypeScript and Electron SDK/docs/sdk/typescript
  • Jobs and polling/docs/manage/jobs
  • Webhooks/docs/manage/webhooks
  • Manage mascots and assets/docs/manage/collections
  • Connect an AI agent/docs/ai-agents
  • Masko in ChatGPT/docs/ai-tools/chatgpt
  • Masko for Cursor/docs/ai-tools/cursor
  • Masko for Muse/docs/ai-tools/muse
  • Masko skill for coding agents/docs/ai-tools/skills
  • 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

Create your first mascot

One sentence becomes your mascot's first reference image: the picture Masko reads before every new pose and animation, so the character keeps the same look.

5 min · 1 credit · Studio or API

Do it in Studio

  1. Open Create a mascot on the Create with AI tab.
  2. Write one sentence in Describe your mascot, such as "A friendly orange fox with a blue scarf, for a cooking app". Stuck? Press Give me ideas.
  3. Optional: pick a Style card and a few Design touches.
  4. Press Generate · 1 credit. Each try appears under Your tries, and Generate another draws one more for 1 credit.
  5. Click the try you like. To fix a detail, write it in Change something and press Refine · 1 credit.
  6. Fill in Name your mascot and press Create mascot.

Do it with the API

Create a key with write access in API keys. Run these calls on your server or in a terminal, never in browser code.

export MASKO_API_KEY=masko_YOUR_KEY

1. Create a project

A project groups your mascots. It is free.

curl -X POST https://api.masko.ai/v1/projects \
  -H "Authorization: Bearer $MASKO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "My App" }'

Save data.id as PROJECT_ID.

2. Create the mascot from a sentence

Send a prompt with no reference images, and Masko draws the first reference for 1 credit, refunded if drawing or saving fails. A retry with the same Idempotency-Key and body is never charged twice.

curl -X POST https://api.masko.ai/v1/mascots \
  -H "Authorization: Bearer $MASKO_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: first-mascot-001" \
  -d '{
    "name": "Felix the Fox",
    "project_id": "PROJECT_ID",
    "prompt": "A friendly orange fox with a blue scarf, for a cooking app"
  }'

Save data.id as MASCOT_ID. Optional fields: style takes a preset ID from GET /v1/styles, and design_touches takes ideas such as ["proportions", "eyes-big", "mood-cozy"] (see create from text).

3. Look at the reference

The asset's file_url is a signed link that expires, so keep the asset ID and read it again for a fresh link.

curl https://api.masko.ai/v1/assets/REFERENCE_ASSET_ID \
  -H "Authorization: Bearer $MASKO_API_KEY"

Optional: compare drafts before you choose

Preview several takes at 1 credit each, then create the mascot from the one you like for no extra credits. Preview links expire after an hour (expires_in: 3600).

curl -X POST https://api.masko.ai/v1/generate/preview \
  -H "Authorization: Bearer $MASKO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A friendly orange fox with a blue scarf, for a cooking app",
    "count": 4
  }'

Then send the chosen url to POST /v1/mascots as "reference_image_urls": ["URL_FROM_PREVIEW"], with name, project_id and the same prompt.

Is there a job to wait for?

No. Creating a mascot answers once the reference is drawn, so the call takes a little while, but there is nothing to poll. Poses and animations return a job_id; the next tutorial shows how to wait for one.

What you get

  • A mascot with an id, a name and a slug. The slug becomes part of its hosted links, such as https://assets.masko.ai/{prefix}/felix-the-fox/....
  • One reference image, a PNG. A mascot holds up to 6 references, and more angles give steadier results. See reference images.
  • Hosting on by default for mascots created with the API (settings.cdn_enabled: true), so your next files get permanent links. Asset hosting is billed separately from credits.

Using an AI agent?

Paste this into an agent connected to the Masko MCP server at https://masko.ai/api/mcp (setup for Cursor or ChatGPT), or into one with the Masko skill and an API key.

Create my first Masko mascot by following
https://masko.ai/docs/tutorials/first-mascot
My product: <what it does and who it is for>.
Use the Masko MCP tools if they are connected. Otherwise use the REST API at
https://api.masko.ai/v1 with MASKO_API_KEY from my environment. Never print the
key or put it in browser code.
Before any paid call, tell me the credits and wait for my OK. It should be 1 credit.
When it is done, show me the reference image and give me the mascot ID.

Next