> ## Documentation Index
> Fetch the complete documentation index at: https://docs.poyo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Z-Image

> Z-Image API 根据提示词生成图像，或编辑恰好一张参考图。文生图需要指定宽高比，可选 1:1、4:3、3:4、16:9 或 9:16。

> [!TIP]
>
> 1. 提交后会返回 `task_id`。如果提供了 `callback_url`，当任务状态变为 `finished` 或 `failed` 时，系统会向 `callback_url` 发送 POST 请求。
> 2. 无论是否提供 `callback_url`，都可以通过统一的[查询任务状态](https://docs.poyo.ai/zh/api-manual/task-management/status.md)接口获取结果。

使用 Z-Image 模型生成高质量图像。通过统一的请求结构同时支持文生图和图像编辑。

`z-image` 使用统一的请求格式：

* 省略 `input.image_urls` 时，请求按文生图处理
* 提供 `input.image_urls` 时，请求自动按图像编辑处理

## 模型

* **z-image** - 统一的文生图与图像编辑模型

## 必填参数

* `prompt` - 必填提示词，最多 `1000` 个字符

## 可选参数

* `size` - 文生图必填，图像编辑可选。支持的值：`1:1`、`4:3`、`3:4`、`16:9`、`9:16`
* `image_urls` - 可选，用于编辑的参考图数组，必须恰好包含 `1` 个图像 URL
* `enable_safety_checker` - 可选布尔值，安全检查开关，默认为 `true`

## 示例

使用统一提交接口：`POST /api/generate/submit`

文生图示例：

```bash theme={"dark"}
curl --request POST \
  --url https://api.poyo.ai/api/generate/submit \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "z-image",
    "callback_url": "https://your-domain.com/callback",
    "input": {
      "prompt": "A serene mountain landscape at sunset with vibrant colors",
      "size": "1:1",
      "enable_safety_checker": true
    }
  }'
```

图像编辑示例：

```bash theme={"dark"}
curl --request POST \
  --url https://api.poyo.ai/api/generate/submit \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "z-image",
    "callback_url": "https://your-domain.com/callback",
    "input": {
      "prompt": "Turn this product photo into a premium studio shot with soft rim lighting",
      "image_urls": ["https://example.com/reference-image.png"],
      "size": "4:3",
      "enable_safety_checker": true
    }
  }'
```

## 注意事项

* `input.image_urls[0]` 用作编辑参考图
* 存在 `image_urls` 时，可以省略 `size`


## OpenAPI

````yaml zh/api-manual/image-series/z-image.json POST /api/generate/submit
openapi: 3.0.0
info:
  title: PoYo AI - Z-Image API
  description: Z-Image 生成，统一支持文生图与图像编辑
  version: 1.0.0
servers:
  - url: https://api.poyo.ai
    description: 生产环境
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      tags:
        - Z-Image
      summary: 提交 Z-Image 生成任务
      description: 使用 Z-Image 模型生成图像，统一支持文生图与图像编辑
      operationId: submitZImageTask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitRequest'
            examples:
              z-image-text:
                summary: Z-Image 文生图
                value:
                  model: z-image
                  callback_url: https://your-domain.com/callback
                  input:
                    prompt: A serene mountain landscape at sunset with vibrant colors
                    size: '1:1'
                    enable_safety_checker: true
              z-image-edit:
                summary: Z-Image 图像编辑
                value:
                  model: z-image
                  callback_url: https://your-domain.com/callback
                  input:
                    prompt: >-
                      Turn this product photo into a premium studio shot with
                      soft rim lighting
                    image_urls:
                      - https://example.com/reference-image.png
                    size: '4:3'
                    enable_safety_checker: true
      responses:
        '200':
          description: 任务提交成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResponse'
        '400':
          description: 请求参数无效
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 未授权：API Key 无效
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SubmitRequest:
      type: object
      required:
        - model
        - input
      properties:
        model:
          type: string
          description: Z-Image 模型标识符
          enum:
            - z-image
        callback_url:
          type: string
          format: uri
          description: 接收结果通知的 Webhook 回调 URL
          example: https://your-domain.com/callback
        input:
          type: object
          required:
            - prompt
          description: >-
            生成的输入参数。文生图时 `size` 必填。存在 `image_urls` 时，请求会自动路由到图像编辑，此时 `size`
            变为可选。
          properties:
            prompt:
              type: string
              description: 描述期望输出的生成提示词
              maxLength: 1000
              example: A beautiful sunset over the ocean
            image_urls:
              type: array
              items:
                type: string
                format: uri
              maxItems: 1
              description: 可选的编辑参考图数组，必须且只能包含 1 个公开图像 URL。支持格式：JPEG、PNG、WEBP。最大 10MB。
              example:
                - https://example.com/reference-image.png
            size:
              type: string
              description: 图像尺寸比例。文生图时必填，图像编辑时可选。
              enum:
                - '1:1'
                - '4:3'
                - '3:4'
                - '16:9'
                - '9:16'
              example: '1:1'
            enable_safety_checker:
              type: boolean
              description: 可选的安全检查开关。省略时默认为 true。
              default: true
              example: true
    SubmitResponse:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          example: 200
          description: >-
            业务状态码。`200` 表示成功，其他值都表示请求失败。请务必检查这个字段：部分参数校验错误会以 HTTP 200 返回，响应体里的
            `code` 为 `400`。


            - `200`：成功

            - `400`：请求参数无效

            - `401`：API Key 缺失或无效

            - `402`：积分不足

            - `403`：没有权限

            - `404`：资源不存在

            - `408`：请求超时

            - `429`：请求频率超限

            - `500`：服务器内部错误

            - `502`：上游服务错误

            - `503`：服务暂不可用


            详见[错误码](/zh/api-manual/error-codes)。
          enum:
            - 200
            - 400
            - 401
            - 402
            - 403
            - 404
            - 408
            - 429
            - 500
            - 502
            - 503
        data:
          type: object
          required:
            - task_id
            - status
            - created_time
          properties:
            task_id:
              type: string
              example: task-unified-1757165031-uyujaw3d
              description: 任务唯一标识，用于查询任务状态
            status:
              type: string
              enum:
                - not_started
                - running
                - finished
                - failed
              example: not_started
              description: >-
                任务状态。提交后立即返回时始终为
                `not_started`。后续状态请通过[查询任务状态](/zh/api-manual/task-management/status)接口或
                `callback_url` 获取。


                - `not_started`：排队中，等待处理

                - `running`：生成中

                - `finished`：已完成，结果在 `files` 或 `output` 中

                - `failed`：失败，详情见 `error_message`
            created_time:
              type: string
              format: date-time
              example: '2025-11-12T10:30:00'
              description: 任务创建时间，ISO 8601 格式
    ErrorResponse:
      type: object
      required:
        - code
        - error
      properties:
        code:
          type: integer
          example: 400
          description: >-
            业务状态码。`200` 表示成功，其他值都表示请求失败。请务必检查这个字段：部分参数校验错误会以 HTTP 200 返回，响应体里的
            `code` 为 `400`。


            - `200`：成功

            - `400`：请求参数无效

            - `401`：API Key 缺失或无效

            - `402`：积分不足

            - `403`：没有权限

            - `404`：资源不存在

            - `408`：请求超时

            - `429`：请求频率超限

            - `500`：服务器内部错误

            - `502`：上游服务错误

            - `503`：服务暂不可用


            详见[错误码](/zh/api-manual/error-codes)。
          enum:
            - 200
            - 400
            - 401
            - 402
            - 403
            - 404
            - 408
            - 429
            - 500
            - 502
            - 503
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
              example: Invalid request parameters
              description: 描述错误原因的错误信息
            type:
              type: string
              example: invalid_request_error
              description: 错误类型标识
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        所有 API 接口都需要 Bearer Token 认证。


        创建 API Key：登录 PoYo，进入 **仪表盘 → API
        密钥**（[poyo.ai/zh/dashboard/api-key](https://poyo.ai/zh/dashboard/api-key)），点击创建
        Key。


        在请求头中添加：


        ```

        Authorization: Bearer YOUR_API_KEY

        ```

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.