Skip to main content

​
Steps

1

Register Modellix

Log in to the Modellix console.
2

Get API Key

In the Modellix console, go to “API Key” and create an API Key.
The API Key is only displayed once after creation, so be sure to save it first.
3

Use the API

Find the model you want to use in Model API, and call the API using your API Key. For example:
curl --request POST \
  --url https://api.modellix.ai/api/v1/alibaba/qwen-image-plus/async \
  --header 'Authorization: Bearer <your_api_key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "A cute cat playing in a garden on a sunny day"
}
'
Since model calls are asynchronous tasks, after a successful call, you will first receive a task_id as shown below:
{
  "code": 0,
  "message": "success",
  "data": {
    "status": "pending",
    "task_id": "task-abc123",
    "model_id": "qwen-image-plus",
    "get_result": {
      "method": "GET",
      "url": "https://api.modellix.ai/api/v1/tasks/task-abc123"
    }
  }
}
4

Get the Result

You can query the task result later using the task_id. For example:
curl --request GET \
  --url https://api.modellix.ai/api/v1/tasks/{task_id} \
  --header 'Authorization: Bearer <your_api_key>'
After a successful query, you will get the generated result. For example:
{
  "code": 0,
  "message": "success",
  "data": {
    "status": "success",
    "task_id": "task-abc123",
    "model_id": "qwen-image-plus",
    "duration": 3500,
    "result": {
      "resources": [
        {
          "url": "https://cdn.example.com/images/abc123.png",
          "type": "image",
          "width": 1024,
          "height": 1024,
          "format": "png",
          "role": "primary"
        }
      ],
      "metadata": {
        "image_count": 1,
        "request_id": "req-123456"
      },
      "extensions": {
        "submit_time": "2024-01-01T10:00:00Z",
        "end_time": "2024-01-01T10:00:03Z"
      }
    }
  }
}
The model’s generated results will all be placed in the result object.
You can find the generated image URL in the result. For example:
{
  "url": "https://cdn.example.com/images/abc123.png"
}
5

Enjoy the Result

You have now successfully used the Modellix model API and obtained the generated result.
Generated results are only saved for 24 hours, so please make sure to save them promptly.

​
Error Handling

All error responses follow a unified JSON format: 
{
  "code": 400,
  "message": "Invalid parameters: parameter 'prompt' is required"
}
  • code (integer) — equals the HTTP status code (0 on success)
  • message (string) — formatted as "<Category>: <detail>"

​
Error Codes

HTTP StatusDescriptionCommon ScenariosRetryable
400Bad RequestMissing required parameters, invalid format, invalid valuesNo — fix parameters first
401UnauthorizedInvalid API key, missing API key, expired API keyNo — provide a valid key
402Payment RequiredInsufficient balance, account in arrearsNo — recharge your account
404Not FoundTask ID not found, model not found, provider not foundNo — check resource ID
429Too Many RequestsRate limit exceeded, concurrent limit exceededYes — use exponential backoff
500Internal Server ErrorInternal processing error, unexpected errorYes — retry up to 3 times
503Service UnavailableService temporarily unavailable, circuit breaker openYes — retry with backoff
For 429 responses, check the X-RateLimit-Reset header to know when you can retry. Use exponential backoff (1 s → 2 s → 4 s) for 500 and 503 errors.