# z-image-base-text-to-image-lora

> Z-Image-Base LoRA (6B) text-to-image and image-to-image generation model with external LoRA support (up to 3 LoRAs) and aspect ratio selection.

## Overview

- **Endpoint**: `POST https://api.muapi.ai/api/v1/z-image-base-text-to-image-lora`
- **Model ID**: `z-image-base-text-to-image-lora`
- **Category**: lora support
- **Variant**: Z-Image Base LoRA
- **Family**: image-generation
- **Cost**: 0.01 credits per call (some models compute cost dynamically based on params)

## API Usage

MuApi uses a **submit-then-poll** pattern: submit a job, get a `request_id`, then poll the predictions endpoint until `status` is `completed`. Optionally pass `?webhook=YOUR_URL` on the submit call to receive a POST callback when the job finishes (skip polling).

**Authentication**: send your MuApi key in the `x-api-key` header. Get one at https://muapi.ai/access-keys.

### 1. Submit a job

```http
POST https://api.muapi.ai/api/v1/z-image-base-text-to-image-lora
Content-Type: application/json
x-api-key: YOUR_API_KEY
```

**Minimum (required only):**

```json
{
  "prompt": "<prompt>"
}
```

**Full example (all params):**

```json
{
  "prompt": "<prompt>",
  "image_url": "https://example.com/your-image_url",
  "loras": [
    {
      "path": "<path>",
      "scale": 1
    }
  ],
  "aspect_ratio": "1:1",
  "strength": 0.6,
  "output_format": "jpeg"
}
```

**Response:**

```json
{
  "request_id": "abc123",
  "status": "processing"
}
```

### 2. Poll for the result

```http
GET https://api.muapi.ai/api/v1/predictions/{request_id}/result
x-api-key: YOUR_API_KEY
```

Possible `status` values: `queued`, `pending`, `processing`, `completed`, `failed`, `cancelled`. Poll every 2-5 seconds until terminal. When `completed`, the result URLs are in the `outputs` array.

**Example response when `completed`:**

```json
{
  "id": "abc123",
  "status": "completed",
  "outputs": [
    "https://cdn.muapi.ai/.../output.png"
  ],
  "urls": {
    "get": "https://api.muapi.ai/api/v1/predictions/abc123/result"
  },
  "created_at": "2026-05-08T12:34:56Z",
  "has_nsfw_contents": []
}
```

### cURL

```bash
# 1. Submit
REQUEST_ID=$(curl -s -X POST https://api.muapi.ai/api/v1/z-image-base-text-to-image-lora \
  -H "x-api-key: $MUAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"<prompt>"}' | jq -r .request_id)

# 2. Poll until completed
while :; do
  RESP=$(curl -s https://api.muapi.ai/api/v1/predictions/$REQUEST_ID/result -H "x-api-key: $MUAPI_API_KEY")
  STATUS=$(echo "$RESP" | jq -r .status)
  [ "$STATUS" = "completed" ] && echo "$RESP" | jq .outputs && break
  [ "$STATUS" = "failed" ] && echo "$RESP" && exit 1
  sleep 3
done
```

### Python

```python
import os, time, requests

API = "https://api.muapi.ai/api/v1"
headers = {"x-api-key": os.environ["MUAPI_API_KEY"]}

r = requests.post(f"{API}/z-image-base-text-to-image-lora", headers=headers, json={"prompt":"<prompt>"})
request_id = r.json()["request_id"]

while True:
    res = requests.get(f"{API}/predictions/{request_id}/result", headers=headers).json()
    if res["status"] == "completed":
        print(res["outputs"]); break
    if res["status"] == "failed":
        raise RuntimeError(res.get("error")); 
    time.sleep(3)
```

## Input Schema

The API accepts the following input parameters:

- **`prompt`** (`string`, _required_):
  The positive prompt for the generation.

- **`image_url`** (`string`, _optional_):
  URL of the reference image to guide generation (optional).

- **`loras`** (`array`, _optional_):
  List of LoRAs to apply (maximum 3).
  - **`loras[].path`** (`string`, _optional_): Civitai model ID (e.g. civitai:1642876@1864626) or HuggingFace URL/path.
  - **`loras[].scale`** (`number`, _optional_): Weight / strength scale of the LoRA.
    - Default: `1`

- **`aspect_ratio`** (`string`, _optional_):
  Output aspect ratio, automatically mapped to pixel dimensions.
  - Default: `"1:1"`
  - Options: `"1:1"`, `"16:9"`, `"9:16"`, `"4:3"`, `"3:4"`, `"3:2"`, `"2:3"`, `"21:9"`, `"9:21"`

- **`strength`** (`number`, _optional_):
  Controls the strength of the transformation for reference image.
  - Default: `0.6`

- **`output_format`** (`string`, _optional_):
  Format of the generated image.
  - Default: `"jpeg"`
  - Options: `"jpeg"`, `"png"`, `"webp"`

## Output Schema

The polling endpoint returns the following fields:

- **`id`** (`string`): The request ID.
- **`status`** (`string`): One of `queued`, `pending`, `processing`, `completed`, `failed`, `cancelled`.
- **`outputs`** (`array`): URLs to generated images/videos/audio. Empty until `status` is `completed`.
- **`urls.get`** (`string`): Self-link to re-fetch this prediction.
- **`error`** (`string` | `null`): Error message if `status` is `failed`.
- **`created_at`** (`string`): ISO-8601 timestamp of when the request was created.
- **`has_nsfw_contents`** (`array of boolean`): Per-output NSFW detection flags.

## Webhooks (optional)

Append `?webhook=https://your-server/path` to the submit URL. When the job reaches a terminal state, MuApi will POST the same shape as the polling response to your URL — no polling needed.

## Agent Integration

MuApi ships an MCP server and CLI so agents (Claude Code, Cursor, custom) can call this endpoint without writing HTTP code:

```bash
# Install the CLI
npm install -g muapi-cli

# Authenticate once
muapi auth login

# Expose all MuApi models as MCP tools to your agent
muapi mcp serve
```

The MCP server exposes tools that wrap submit + poll for every model, including `z-image-base-text-to-image-lora`. See `muapi --help` for category-specific shortcuts (`muapi image generate`, `muapi video from-image`, etc.).

## Related Models
- [Z-Image Turbo LoRA](https://muapi.ai/playground/z-image-turbo-text-to-image-lora)
- [Z-Image Base LoRA](https://muapi.ai/playground/z-image-base-text-to-image-lora)
- [Z-Image Turbo Image-to-Image LoRA](https://muapi.ai/playground/z-image-turbo-image-to-image-lora)

## Resources
- [Playground Page](https://muapi.ai/playground/z-image-base-text-to-image-lora)
- [API Reference](https://muapi.ai/playground/z-image-base-text-to-image-lora?tab=2)
- [Global llms.txt](https://muapi.ai/llms.txt)