Quickstart
Create your first mascot and get CDN URLs in 5 minutes.
Using an AI coding agent? The CLI or MCP server may be faster than raw API calls.
Prerequisites: You need an API key. Create one in the Developer dashboard.
Step 1: Create a Project
Projects group related collections together. Create one to get started.
curl -X POST https://api.masko.ai/v1/projects \
-H "Authorization: Bearer masko_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "My App" }'Step 2: Create a Collection
A collection represents a single mascot character. Give it a name and a description of the character you want.
curl -X POST https://api.masko.ai/v1/collections \
-H "Authorization: Bearer masko_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Felix the Fox",
"project_id": "PROJECT_ID",
"description": "A friendly orange fox mascot wearing a blue scarf"
}'Step 3: Generate an Animation
Request a generation by specifying the type and a prompt. The API returns a job ID you can poll for status.
curl -X POST https://api.masko.ai/v1/collections/COLLECTION_ID/generate \
-H "Authorization: Bearer masko_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "animation",
"prompt": "waving hello",
"duration": 3
}'Step 4: Check the Result
Poll the job endpoint until the status is completed. The response includes download URLs for all generated assets.
curl https://api.masko.ai/v1/jobs/JOB_ID \
-H "Authorization: Bearer masko_YOUR_API_KEY"
# Response:
# {
# "id": "JOB_ID",
# "status": "completed",
# "assets": [
# { "type": "video", "url": "https://..." },
# { "type": "webm", "url": "https://..." }
# ]
# }Once your assets are published to the CDN, the URLs are permanent and served from assets.masko.ai with global edge caching.
CLI Alternative
The same flow with the Masko CLI (great for AI agents):
npx @masko/cli login
masko projects create --name "My App"
masko mascots create --project PROJECT_ID --prompt "A friendly orange fox mascot wearing a blue scarf"
masko generate --mascot MASCOT_ID --type animation --prompt "waving hello" --duration 3 --wait