Developers API

Create Coloring Page from Image

Convert an uploaded image into a coloring page using AI technology.

Request Parameters

Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "status": "in_queue",
  "created": "2025-10-14 12:34:56"
}

Example Request

curl -X POST https://mimi-panda.com/api/coloring \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "image=@/path/to/image.jpg" \
  -F "version=v2" \
  -F "type=v2_detailed"

Create Paint-by-Numbers

Create a paint-by-numbers template from an uploaded image or AI-generated image from a text prompt.

Request Parameters

Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "status": "in_queue",
  "created": "2025-10-14 12:34:56"
}

Example Request (with Image)

curl -X POST https://mimi-panda.com/api/pbn \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "image=@/path/to/image.jpg" \
  -F "numberOfColors=40" \
  -F "segmentsComplexity=level2"

Example Request (with Prompt)

curl -X POST https://mimi-panda.com/api/pbn \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "prompt=Beautiful sunset over mountains" \
  -F "numberOfColors=30" \

Generate AI Coloring Page from Prompt

Generate a coloring page using AI from a text prompt, optionally guided by a reference image. Without image, this is text-to-image. With image, the request is image-to-image: the model keeps the main subject recognizable and preserves framing, crop, pose, and placement unless the prompt asks otherwise, then applies the instruction as a black-and-white coloring page in the chosen style.

Request Parameters

Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "status": "in_queue",
  "created": "2025-10-14 12:34:56"
}

Example Request

curl -X POST https://mimi-panda.com/api/service/ai/coloring \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A magical unicorn in an enchanted forest",
    "style": "kids_coloring_page",
    "aspectRatio": "3x4"
  }'

Example Request (with Reference Image)

curl -X POST https://mimi-panda.com/api/service/ai/coloring \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "prompt=Turn this into a coloring page of a cat sitting in a garden" \
  -F "style=kids_coloring_page" \
  -F "image=@/path/to/reference.jpg"

Generate AI Image from Prompt

Generate a high-quality AI image from a text prompt, optionally guided by a reference image. Without image, this is text-to-image. With image, the request is image-to-image: the model keeps the main subject recognizable and preserves framing, crop, pose, and placement unless the prompt asks otherwise, then produces a polished full-color image following the prompt.

Request Parameters

Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "status": "in_queue",
  "created": "2025-10-14 12:34:56"
}

Example Request

curl -X POST https://mimi-panda.com/api/service/ai/image \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A futuristic cityscape at night with neon lights",
    "aspectRatio": "16x9"
  }'

Example Request (with Reference Image)

curl -X POST https://mimi-panda.com/api/service/ai/image \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "prompt=Paint this scene as a watercolor sunset" \
  -F "aspectRatio=1x1" \
  -F "image=@/path/to/reference.jpg"

Upscale and Enhance Image

Enhance and upscale an image using AI technology to improve quality and resolution.

Request Parameters

Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "status": "in_queue",
  "created": "2025-10-14 12:34:56"
}

Example Request

curl -X POST https://mimi-panda.com/api/image/upscale \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "image=@/path/to/image.jpg" \
  -F "upscale=4"

Apply AI Filter to Image

Transform an image by applying AI-powered artistic filters and effects.

Request Parameters

Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "status": "in_queue",
  "created": "2025-10-14 12:34:56"
}

Example Request

curl -X POST https://mimi-panda.com/api/image/filter \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "image=@/path/to/image.jpg" \
  -F "filterType=artistic" \
  -F "strength=0.7"

Generate Name Coloring Page

Generate a coloring page featuring a stylized name using AI, with optional decorative elements inside and around the text and background decorations.

Request Parameters

Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "status": "in_queue",
  "created": "2025-10-14 12:34:56"
}

Example Request

curl -X POST https://mimi-panda.com/api/ai/name-coloring \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Emma",
    "fontStyle": "bubble",
    "aspectRatio": "3x2",
    "elementInText": "flowers",
    "elementAroundText": "butterflies",
    "backgroundDecoration": "garden"
  }'

List Generated Items

List the authenticated user's generated items from api_model_keys with optional filters and pagination. Returns a slim payload suitable for mobile galleries and dashboards — use Get Generated Item by UUID for full detail (colors, prompts, image URLs).

Query Parameters

Response

{
  "data": [
    {
      "key": "550e8400-e29b-41d4-a716-446655440000",
      "type": "pbn",
      "status": "ready",
      "created": "2026-08-28 10:00:00",
      "title": null,
      "thumbnail": "https://mimi-panda.com/storage/pbn/picture.jpg"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 24,
    "total": 112
  }
}

thumbnail is null until status is ready.

Example Request

curl -X GET "https://mimi-panda.com/api/service/items?type=pbn&status=ready&page=1&per_page=24" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Get Generated Item by UUID

Retrieve the status and results of a previously created item using its unique identifier. Every response includes a top-level type field with a public API name: coloring, pbn, ai_coloring, ai_image, name_coloring, upscale, or ai_filter (internal DB types such as catalog_coloring are never exposed).

For PBN items that are ready, JSON includes three asset URLs (pbn, picture, source) plus structured color data. For the same downloads available in the web app (PNG/PDF outlines, grayscale, custom-colored SVGs, palette PDFs/CSV/software palettes, etc.), use the dedicated download PBN image and download PBN colors endpoints below.

URL Parameters

Response

The response structure varies depending on the item type:

Coloring Page Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "type": "coloring",
  "status": "ready",
  "created": "2025-10-14 12:34:56",
  "updated": "2025-10-14 12:35:23",
  "images": [
    "https://mimi-panda.com/storage/coloring/image.jpg"
  ]
}

Paint-by-Numbers Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "type": "pbn",
  "status": "ready",
  "created": "2025-10-14 12:34:56",
  "updated": "2025-10-14 12:37:12",
  "images": {
    "pbn": "https://mimi-panda.com/storage/pbn/pbn-image.jpg",
    "picture": "https://mimi-panda.com/storage/pbn/picture.jpg",
    "source": "https://mimi-panda.com/storage/pbn/source.jpg"
  },
  "colors": [
    {
      "number": 1,
      "hex": "#FF5733",
      "name": "Red Orange"
    },
    {
      "number": 2,
      "hex": "#3498DB",
      "name": "Sky Blue"
    }
  ],
  "parameters": {
    "prompt": "Beautiful sunset",
    "numberOfColors": 30,
    "segmentsComplexity": "level2",
    "canvasSize": "16x16",
    "crop": false,
    "palette": null,
    "paletteColors": null,
    "aiFilterType": "none",
    "minArea": 0,
    "thinLineWidth": 1,
    "colorMergeThreshold": 0,
    "thinZoneMerge": 3
  }
}

AI Coloring/Image Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "type": "ai_coloring",
  "status": "ready",
  "created": "2025-10-14 12:34:56",
  "updated": "2025-10-14 12:36:45",
  "images": [
    "https://mimi-panda.com/storage/catalog/image1.jpg",
    "https://mimi-panda.com/storage/catalog/image2.jpg"
  ],
  "parameters": {
    "prompt": "Magical unicorn in forest",
    "style": "fantasy",
    "aspectRatio": "3x4",
    "width": 1024,
    "height": 1365
  }
}

Image Upscale Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "type": "upscale",
  "status": "ready",
  "created": "2025-10-14 12:34:56",
  "updated": "2025-10-14 12:36:12",
  "images": [
    "https://mimi-panda.com/storage/catalog/upscaled-image.jpg"
  ],
  "parameters": {
    "upscale": 4,
    "width": 4096,
    "height": 4096
  }
}

AI Filter Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "type": "ai_filter",
  "status": "ready",
  "created": "2025-10-14 12:34:56",
  "updated": "2025-10-14 12:35:45",
  "images": [
    "https://mimi-panda.com/storage/catalog/filtered-image.jpg"
  ],
  "parameters": {
    "filterType": "artistic",
    "strength": 0.7
  }
}

Name Coloring Page Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "type": "name_coloring",
  "status": "ready",
  "created": "2025-10-14 12:34:56",
  "updated": "2025-10-14 12:36:30",
  "images": "https://mimi-panda.com/storage/catalog/name-coloring.jpg",
  "parameters": {
    "name": "Emma",
    "fontStyle": "bubble",
    "aspectRatio": "3x2",
    "elementInText": "flowers",
    "elementAroundText": "butterflies",
    "backgroundDecoration": "garden",
    "width": 1536,
    "height": 1024
  }
}

Status Values

• in_queue - Task is waiting to be processed
• processing - Task is currently being processed
• ready - Task completed successfully, results are available
• failed - Task failed to complete
• banned - Generated content was rejected by content moderation. This is a terminal status visible only via this endpoint (banned items are excluded from List Generated Items). The response includes a localized error message. Credits are not refunded.

Banned Item Response

{
  "key": "550e8400-e29b-41d4-a716-446655440000",
  "type": "ai_image",
  "status": "banned",
  "created": "2025-10-14 12:34:56",
  "updated": "2025-10-14 12:35:10",
  "error": "The generated image was blocked by content moderation. Please try a different prompt or image."
}

Example Request

curl -X GET https://mimi-panda.com/api/service/item/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Download PBN Image File

Download the paint-by-numbers or related rasterized assets in any format offered in the Profile app once the job status is ready. The UUID must belong to your account.

URL Parameters

Query Parameters (optional unless noted)

Responses

• 200 — File body (Content-Disposition includes a filename)
• 400 — Invalid type, missing parameters for custom, or invalid query validation
• 401 — Missing or invalid token
• 403 — UUID belongs to another user
• 404 — UUID not found, missing files on storage, or not a PBN item
• 409 — Item exists but status is not ready yet
• 500 — Export failed (e.g. PDF generation)

Example: download outlines as SVG

curl -L -o pbn-outlines.svg \
  "https://mimi-panda.com/api/service/item/550e8400-e29b-41d4-a716-446655440000/pbn/download/outlines" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example: download full PBN as PNG with width

curl -L -o pbn.png \
  "https://mimi-panda.com/api/service/item/550e8400-e29b-41d4-a716-446655440000/pbn/download/pbnpng?width=3000" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example: download full PBN as PDF

curl -L -o pbn.pdf \
  "https://mimi-panda.com/api/service/item/550e8400-e29b-41d4-a716-446655440000/pbn/download/pbnpdf" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example: download grayscale as PDF

curl -L -o pbn-grayscale.pdf \
  "https://mimi-panda.com/api/service/item/550e8400-e29b-41d4-a716-446655440000/pbn/download/grayscalepdf" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example: custom SVG (numbered template, colored strokes)

curl -L -o pbn-custom.svg \
  "https://mimi-panda.com/api/service/item/550e8400-e29b-41d4-a716-446655440000/pbn/download/custom?download-type=pbn&download-strokes-color=%23000000&download-numbers-color=%23ffffff&download-frame=no" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Download PBN Colors File

Download the palette / color legend for a ready paint-by-numbers item in spreadsheet, PDF/image chart, or third-party palette formats (aligned with downloads in the Profile app).

URL Parameters

When using type=swatches, detect the exact returned format from the response metadata: check Content-Disposition for filename extension and X-Mimi-Colors-Format for swatches or zip.

Responses

• 200 — File attachment (format depends on type)
• 400 — Invalid color export type
• 401, 403, 404, 409 — Same semantics as the PBN image download endpoint

Example Request

curl -L -o colors.csv \
  "https://mimi-panda.com/api/service/item/550e8400-e29b-41d4-a716-446655440000/pbn/colors/csv" \
  -H "Authorization: Bearer YOUR_API_TOKEN"