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

# OpenAI Image Editing

> Interface description: Compatible endpoint of OpenAI Images API `/v1/images/edits` (image-to-image). The request, response and error formats fully comply with the OpenAI specifications: `application/json` and `multipart/form-data` are supported (images and mask files can be uploaded directly), OpenAI original `ImagesResponse` is returned, and the AiToEarn universal response package is not used; the image link is the original return from the upstream and is not transferred. Authentication uses `Authorization: Bearer <API Key>` (OpenAI SDK carries it by default). Existing OpenAI SDK or ecological tools only need to replace the baseURL and API Key to access, and billing is based on AiToEarn points.

The model value comes from `data[n].name` returned by the ["Image Editing Model"](/en/api-reference/get-api-ai-models-image-edit) interface. If you need the AiToEarn universal response format (`code === 0`) and the stable image link after dumping, please use the ["Edit Image"](/en/api-reference/post-api-ai-image-edit) interface instead.



## OpenAPI

````yaml /openapi/en/aitoearn.openapi.json post /api/ai/images/edits
openapi: 3.0.1
info:
  title: AiToEarn Open Platform API
  description: >-
    AiToEarn Open Platform API. You can switch between the China and
    international sites for testing. Business success is determined by whether
    the response body has code === 0.
  version: 1.0.0
  contact: {}
servers:
  - url: https://aitoearn.cn
    description: China site
  - url: https://aitoearn.ai
    description: International site
security: []
tags:
  - name: AI Services
  - name: AI Services/Video Generation
  - name: AI Services/Image Generation
  - name: Channel Management
  - name: Channel Management/Accounts
  - name: Channel Management/Publishing
  - name: Channel Management/Platforms
  - name: Channel Management/Works
  - name: Channel Management/Account Groups
  - name: Channel Management/Authorization
  - name: Asset Management
  - name: AI Services/Large Language Models
paths:
  /api/ai/images/edits:
    post:
      tags:
        - AI Services/Image Generation
      summary: OpenAI Image Editing
      description: >-
        Interface description: Compatible endpoint of OpenAI Images API
        `/v1/images/edits` (image-to-image). The request, response and error
        formats fully comply with the OpenAI specifications: `application/json`
        and `multipart/form-data` are supported (images and mask files can be
        uploaded directly), OpenAI original `ImagesResponse` is returned, and
        the AiToEarn universal response package is not used; the image link is
        the original return from the upstream and is not transferred.
        Authentication uses `Authorization: Bearer <API Key>` (OpenAI SDK
        carries it by default). Existing OpenAI SDK or ecological tools only
        need to replace the baseURL and API Key to access, and billing is based
        on AiToEarn points.


        The model value comes from `data[n].name` returned by the ["Image
        Editing Model"](/en/api-reference/get-api-ai-models-image-edit)
        interface. If you need the AiToEarn universal response format (`code ===
        0`) and the stable image link after dumping, please use the ["Edit
        Image"](/en/api-reference/post-api-ai-image-edit) interface instead.
      operationId: RelayController_imagesEdits
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelayImageEditDto'
            examples: {}
        required: true
      responses:
        '200':
          description: >-
            Native third-party protocol response or SSE data, not wrapped in the
            AiToEarn common response envelope.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                description: >-
                  Native third-party protocol response, not wrapped in the
                  AiToEarn common response envelope.
              examples:
                success:
                  summary: Native third-party success response
                  value:
                    id: RelayController_imagesEdits_example
                    object: response
            text/event-stream:
              schema:
                type: string
                description: SSE streaming response.
      deprecated: false
      security:
        - apikey-header-Authorization: []
components:
  schemas:
    RelayImageEditDto:
      type: object
      properties:
        model:
          type: string
          description: >-
            Image editing model name. First call the ["Image Editing
            Models"](/en/api-reference/get-api-ai-models-image-edit) interface
            (`GET /api/ai/models/image/edit`) and pass in the `data[n].name`
            returned by it; the size, maximum number of input images and price
            supported by each model shall be subject to the return of this
            interface.
        image:
          anyOf:
            - type: string
            - type: array
              items:
                type: string
          description: Picture list
        prompt:
          type: string
          description: prompt word
        mask:
          type: string
          description: >-
            Mask image URL for **partial redraw** (optional). It needs to be a
            PNG image with the same size as `image`: the completely transparent
            area (alpha is 0) represents the part that needs to be redrawn
            according to the prompt word, and the opaque area remains unchanged.
            Edit the entire image when not uploading.
        'n':
          type: integer
          minimum: 1
          maximum: 9007199254740991
          description: Generate quantity
        size:
          type: string
          description: >-
            Image size. The optional values ​​vary from model to model, and are
            subject to the `data[n].sizes` returned by the ["Image Editing
            Models"](/en/api-reference/get-api-ai-models-image-edit) interface;
            the prices for different sizes are different, see `data[n].pricing`.
        response_format:
          type: string
          enum:
            - url
            - b64_json
          description: Return format
      required:
        - model
        - image
        - prompt
      additionalProperties: true
  securitySchemes:
    apikey-header-Authorization:
      type: apiKey
      in: header
      name: Authorization
      description: 'Used by OpenAI-compatible endpoints. Example: Bearer <token>.'

````