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

> Microsoft's image-editing model for targeted changes to objects, styling, and text in a source image. It can adjust specific details while preserving the surrounding composition.

Poll the returned task URL to retrieve the PNG. [Query Task Result](https://docs.modellix.ai/api/get-task-result.md)


## OpenAPI

````yaml /media-model-api/microsoft/microsoft-i2i.json post /microsoft/mai-image-2.7-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.7-edit:
    post:
      summary: MAI Image 2.7 Edit
      description: >-
        Microsoft's image-editing model for targeted changes to objects,
        styling, and text in a source image. It can adjust specific details
        while preserving the surrounding composition.
      operationId: maiImage27EditAsync
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MAIImage27EditRequest'
            examples:
              basic:
                summary: Single Source Image
                value:
                  prompt: >-
                    Keep the subjects and composition, and give the background a
                    warm sunset color grade.
                  images:
                    - >-
                      https://dashscope.oss-cn-beijing.aliyuncs.com/images/dog_and_girl.jpeg
              image_url_object:
                summary: Image URL Object
                value:
                  prompt: >-
                    Keep the subjects and composition, and give the background a
                    warm sunset color grade.
                  images:
                    - image_url: >-
                        https://dashscope.oss-cn-beijing.aliyuncs.com/images/dog_and_girl.jpeg
      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-image-2-7-edit-001
                  model_id: microsoft/mai-image-2.7-edit
                  get_result:
                    method: GET
                    url: >-
                      https://api.modellix.ai/api/v1/tasks/task-mai-image-2-7-edit-001
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    MAIImage27EditRequest:
      type: object
      required:
        - prompt
        - images
      description: Apply a prompt-guided edit to one source image and return one PNG.
      properties:
        prompt:
          type: string
          minLength: 1
          maxLength: 32000
          description: >-
            Describe the edit to apply. The platform limit is 32,000 UTF-8
            bytes.
          example: >-
            Keep the subjects and composition, and give the background a warm
            sunset color grade.
        images:
          type: array
          minItems: 1
          maxItems: 1
          description: >-
            Provide exactly one publicly accessible HTTP or HTTPS URL for a JPEG
            or PNG. Use a URL string or an object with an image_url string.
          items:
            oneOf:
              - type: string
                format: uri
                pattern: ^https?://
              - type: object
                required:
                  - image_url
                properties:
                  image_url:
                    type: string
                    format: uri
                    pattern: ^https?://
          example:
            - >-
              https://dashscope.oss-cn-beijing.aliyuncs.com/images/dog_and_girl.jpeg
    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`.'

````

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