Masko API documentation

Create a mascot, generate its poses and animations, and use the completed files in your product. Start with one animation, then add the workflows your integration needs.

01 / START

Your first animation

Create a mascot and a five-second Standard animation in four steps. The example uses 12 credits.

02 / BUILD

Choose a workflow

Generate images, animate a pose, use a reference video, or create design assets.

03 / LOOK UP

Endpoint reference

Find request fields, response schemas and authentication requirements from OpenAPI.

Connect to the API

Create a write-capable key in API keys, save it as MASKO_API_KEY in your server environment, and check your balance:

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

The base URL is https://api.masko.ai/v1. Your key selects the workspace and credit balance. Read authentication and requests and responses for the shared API conventions.

Follow the generation flow

Create a mascot collection from text, an image or a website. A project groups your collections.
Select its reference images to define a consistent appearance.
Generate a pose and animate it. Choose Standard or Premium and review the credit cost before submitting.
Wait for the generation job or receive a webhook. An accepted request or allocated file URL does not mean the media is ready.
Retrieve the completed files in the formats your product needs.

Go further

Interactive canvases: connect poses and transitions into a state machine.
Desktop and SDKs: play authored mascots on macOS using the terminal, Swift or TypeScript.
AI agents: give your coding agent the Masko skill and API documentation.

Use the live OpenAPI specification for the deployed contract. Agents can read the documentation index, complete guides, or query GET /v1/docs?q=animation.