> ## 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.

# MAI Image 2.5 Edit

> [Core Function] MAI Image 2.5 Edit is Microsoft's flagship image editing model. [Strengths] It excels at applying high-quality, prompt-guided edits and transformations to a single source image. [Best For] Highly recommended for: restyling, object/scene modification, and detailed prompt-driven edits. [Limitations] Do NOT provide more than one source image or non-JPEG/PNG inputs; it accepts exactly one JPEG or PNG image, and output is always PNG. [Routing] Use this model by default for quality-sensitive edits. For faster, cheaper edits, route to MAI Image 2.5 Flash Edit.



## OpenAPI

````yaml /model-api/microsoft/microsoft-i2i.json post /microsoft/mai-image-2.5-edit
openapi: 3.1.0
info:
  description: >-
    The image-to-image (image editing) models API from Microsoft Foundry (MAI
    Image). Edits a single source image according to a text prompt and returns
    the result (PNG) synchronously via the async task interface.
  version: 1.0.0
  contact:
    name: Modellix Support
    email: support@modellix.ai
  title: Microsoft MAI Image Image-to-Image Models API
servers:
  - url: https://api.modellix.ai/api/v1
    description: The image-to-image models API from Microsoft Foundry (MAI Image).
security:
  - bearerAuth: []
paths:
  /microsoft/mai-image-2.5-edit:
    post:
      summary: MAI Image 2.5 Edit
      description: >-
        [Core Function] MAI Image 2.5 Edit is Microsoft's flagship image editing
        model. [Strengths] It excels at applying high-quality, prompt-guided
        edits and transformations to a single source image. [Best For] Highly
        recommended for: restyling, object/scene modification, and detailed
        prompt-driven edits. [Limitations] Do NOT provide more than one source
        image or non-JPEG/PNG inputs; it accepts exactly one JPEG or PNG image,
        and output is always PNG. [Routing] Use this model by default for
        quality-sensitive edits. For faster, cheaper edits, route to MAI Image
        2.5 Flash Edit.
      operationId: maiImage25EditAsync
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MAIImageEditRequest'
            examples:
              basic:
                summary: Single source image
                value:
                  prompt: Turn this photo into a watercolor painting
                  images:
                    - https://example.com/photo.png
      responses:
        '200':
          description: Task submitted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskResponse'
              example:
                code: 0
                message: success
                data:
                  status: pending
                  task_id: task-mai-i2i-001
                  model_id: microsoft/mai-image-2.5-edit
                  get_result:
                    method: GET
                    url: https://api.modellix.ai/api/v1/tasks/task-mai-i2i-001
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    MAIImageEditRequest:
      type: object
      required:
        - prompt
        - images
      description: >-
        Microsoft MAI Image edit request. Shared by MAI Image 2.5 Edit and 2.5
        Flash Edit. Accepts exactly one source image (JPEG or PNG); output is
        always PNG.
      properties:
        prompt:
          type: string
          minLength: 1
          maxLength: 32000
          description: Text description of the edit to apply
          example: Turn this photo into a watercolor painting
        images:
          type: array
          minItems: 1
          maxItems: 1
          description: >-
            Exactly one source image. The item is a publicly accessible image
            URL or a base64 data URI (JPEG or PNG only).
          items:
            type: string
            minLength: 1
          example:
            - https://example.com/photo.png
    AsyncTaskResponse:
      type: object
      required:
        - code
        - message
        - data
      properties:
        code:
          type: integer
          description: Response code, 0 indicates success
          example: 0
        message:
          type: string
          description: Response message
          example: success
        data:
          type: object
          required:
            - status
            - task_id
            - model_id
          properties:
            status:
              type: string
              enum:
                - pending
                - processing
              description: Task status
              example: pending
            task_id:
              type: string
              description: Unique task identifier for polling
              example: task-abc123
            model_id:
              type: string
              description: Model ID in `provider/model` format
              example: microsoft/mai-image-2.5-edit
            get_result:
              type: object
              description: API information to query the task result
              properties:
                method:
                  type: string
                  example: GET
                url:
                  type: string
                  example: https://api.modellix.ai/api/v1/tasks/task-abc123
          description: Detailed data about the submitted asynchronous task.
    ErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          example: 400
        message:
          type: string
          example: 'Invalid parameters: parameter ''images'' is required'
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 400
            message: 'Invalid parameters: parameter ''images'' is required'
    Unauthorized:
      description: Unauthorized - Invalid or missing API Key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 401
            message: 'Authentication failed: invalid API key'
    TooManyRequests:
      description: Too many requests - Rate limit exceeded
      headers:
        X-RateLimit-Limit:
          description: Maximum requests per minute
          schema:
            type: integer
            example: 100
        X-RateLimit-Remaining:
          description: Remaining quota in current window
          schema:
            type: integer
            example: 0
        X-RateLimit-Reset:
          description: Rate limit window reset time (Unix timestamp)
          schema:
            type: integer
            example: 1704067260
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 429
            message: >-
              Rate limit exceeded: 100 requests per minute, retry after 60
              seconds
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 500
            message: Internal server error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API Key authentication. Format: `Bearer YOUR_API_KEY`.'

````