Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.modellix.ai/llms.txt

Use this file to discover all available pages before exploring further.

If you are an AI agent, this document provides the essential context and tools you need to interact with Modellix.
Modellix provides a unified API for cutting-edge AI image and video generation models. Since media generation tasks can take some time, Modellix uses an asynchronous API design. Here are the resources and patterns you should use to integrate Modellix into your workflows.

​
Prerequisite: Create an API Key

Currently, we require a human to create a Modellix account and generate an API Key. Once you have an account, you’ll need to create an API key in the console. With an API key, your agent can perform all other tasks.
The API Key is only displayed once after creation. Ensure it is securely stored, typically as a MODELLIX_API_KEY environment variable.

​
Agent Skills

Skills give AI agents specialized knowledge for specific tasks. We provide an official Modellix skill that helps you construct API requests correctly and understand the available models. You can install the Modellix skill with a single command via skills.sh: 
npx skills add https://github.com/modellix/modellix-skill --skill modellix
Or directly from GitHub: 
npx skills add https://github.com/Modellix/modellix-skill/tree/main/modellix-skill

Agent Skill

View installation instructions for Cursor, Claude Code, GitHub Copilot, Codex, and other AI agents.

​
Modellix CLI

The Modellix CLI (modellix-cli) lets you create generation tasks and fetch results directly from the terminal. It’s perfect for agentic workflows and automated scripts. 
# Install the CLI
npm install -g modellix-cli

# Export the API key
export MODELLIX_API_KEY="your_api_key"

# Create a generation task
modellix-cli model invoke \
  --model-slug alibaba/qwen-image-edit \
  --body '{"prompt":"A cute cat playing in a garden on a sunny day"}'

# Fetch the task result using the returned task_id
modellix-cli task get task-abc123

Modellix CLI

Learn more about using the CLI for async model generation workflows.

​
Quick Start Guide

Throughout our documentation, we provide quick start guides for common tasks. Copy the prompt for your agent or click to open in Cursor.

Agent quick start guide for async model generation.

CursorOpen in Cursor