This is the official documentation source for the ModelsLab API, built with Mintlify. The live docs are available at docs.modelslab.com.

What this repo contains

Documentation for the full ModelsLab API surface, organized by product area:

Directory	Description
image-generation/	Text to image, Flux, ControlNet, community models, real-time SD
image-editing/	Inpainting, outpainting, super resolution, background removal, face generation
video-api/	Text to video, image to video, video to video, watermark removal
voice-cloning/	TTS, STT, voice cloning, music generation, song generator, dubbing
faceswap-api/	Face swap (image and video)
3d-api/	Text to 3D, image to 3D
interior-api/	Interior design, room decoration, floor planning
general-api/	Account, billing, subscriptions, cache, NSFW checks
enterprise-api/	Enterprise-tier endpoints across all product areas
mcp-web-api/	MCP server integration and agent control plane
workflows-api/	Workflow execution and management
sdk/	SDK references for Python, TypeScript, Go, PHP, Dart
agents-api/	Agent authentication, billing, and team management
open-source/	Open source projects (ModelQ, ModelsLab MCP)
guides/	End-to-end guides for specific use cases
release-notes/	API and playground changelog

Top-level pages include quickstart.mdx, authentication.mdx, webhooks.mdx, rate-limits.mdx, and error-codes.mdx.

Local development

Install the Mintlify CLI:

npm install -g mintlify

Start the local preview server from the root of this repo (where docs.json lives):

mintlify dev

If the dev server fails to start, run mintlify install to reinstall dependencies.

Contributing

Editing existing pages

Each page is an .mdx file in the corresponding API directory. Edit the file directly and the changes will reflect in the local preview immediately.

Adding a new page

1. Create a new .mdx file in the relevant directory.
2. Add it to the navigation section in docs.json under the correct group.
3. Preview locally to confirm it renders correctly.

Page structure

Pages follow this general structure:

---
title: "Endpoint Name"
description: "Short description of what this endpoint does."
---

## Request
...

## Body
...

## Body Attributes
...

## Response
...

Useful CLI commands

Check for broken internal links:

mintlify broken-links

Validate an OpenAPI file:

mintlify openapi-check <filename-or-url>

Rename a file and update all internal references:

mintlify rename <from> <to>

Deployment

Changes pushed to the default branch are automatically deployed to docs.modelslab.com via the Mintlify GitHub integration.

Support

For API support, visit modelslab.com/support or email support@modelslab.com. For documentation issues, open an issue in this repository. To request new features, join the Discord.