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

# Z-Image Generation

> High-quality image generation with Z-Image

<Tip>
  1. After submission, a `task_id` will be returned. If you provided a `callback_url`, when the task status becomes `finished` or `failed`, a POST request will be sent to the `callback_url`.
  2. Regardless of whether `callback_url` is provided, you can retrieve the response result through the unified [Query Task Status](/api-manual/task-management/status) endpoint.
</Tip>

# Z-Image Generation

Generate high-quality images using the Z-Image model. Supports text-to-image generation with flexible aspect ratios.

## Available Models

* **z-image** - Text-to-image generation


## OpenAPI

````yaml /api-manual/image-series/z-image.json POST /api/generate/submit
openapi: 3.0.0
info:
  title: Vidgo API - Z-Image API
  description: Z-Image Generation
  version: 1.0.0
servers:
  - url: https://api.vidgo.ai
    description: Production server
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      tags:
        - Z-Image
      summary: Submit Z-Image Generation Task
      description: Generate images using Z-Image model
      operationId: submitZImageTask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitRequest'
            examples:
              z-image:
                summary: Z-Image Generation
                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'
      responses:
        '200':
          description: Task submitted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResponse'
components:
  schemas:
    SubmitRequest:
      type: object
      required:
        - model
      properties:
        model:
          type: string
          description: Z-Image model identifier
          enum:
            - z-image
        callback_url:
          type: string
          format: uri
          description: Webhook callback URL for result notifications
          example: https://your-domain.com/callback
        input:
          type: object
          required:
            - prompt
            - size
          description: Input parameters for generation
          properties:
            prompt:
              type: string
              description: Generation prompt describing the desired output
              maxLength: 1000
              example: A beautiful sunset over the ocean
            size:
              type: string
              description: Image size ratio
              enum:
                - '1:1'
                - '4:3'
                - '3:4'
                - '16:9'
                - '9:16'
              example: '1:1'
    SubmitResponse:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          example: 200
          description: HTTP status code
        data:
          type: object
          required:
            - task_id
            - status
            - created_time
          properties:
            task_id:
              type: string
              example: task-unified-1757165031-uyujaw3d
              description: Unique task identifier for status tracking
            status:
              type: string
              enum:
                - not_started
              example: not_started
              description: Initial task status
            created_time:
              type: string
              format: date-time
              example: '2025-11-12T10:30:00'
              description: ISO 8601 timestamp when the task was created
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        All API endpoints require Bearer Token authentication


        Get your API Key:


        Visit the [API Key Management
        Page](https://vidgo.ai/apis/dashboard/api-key) to get your API Key


        Add it to the request header:


        ```

        Authorization: Bearer YOUR_API_KEY

        ```

````