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

# Edit Image

> Uses `gpt-image-1` to edit an images based on a given prompt. Note that the images must be
base64 encoded and all must have the same mime type.



## OpenAPI

````yaml post /api/message/edit_image
openapi: 3.0.3
info:
  title: Trieve API
  description: >-
    Trieve OpenAPI Specification. This document describes all of the operations
    available through the Trieve API.
  contact:
    name: Trieve Team
    url: https://trieve.ai
    email: developers@trieve.ai
  license:
    name: BSL
    url: https://github.com/devflowinc/trieve/blob/main/LICENSE.txt
  version: 0.13.0
servers:
  - url: https://api.trieve.ai
    description: Production server
  - url: http://localhost:8090
    description: Local development server
security: []
tags:
  - name: Invitation
    description: Invitation endpoint. Exists to invite users to an organization.
  - name: Auth
    description: Authentication endpoint. Serves to register and authenticate users.
  - name: User
    description: User endpoint. Enables you to modify user roles and information.
  - name: Organization
    description: >-
      Organization endpoint. Enables you to modify organization roles and
      information.
  - name: Dataset
    description: >-
      Dataset endpoint. Datasets belong to organizations and hold configuration
      information for both client and server. Datasets contain chunks and chunk
      groups.
  - name: Chunk
    description: >-
      Chunk endpoint. Think of chunks as individual searchable units of
      information. The majority of your integration will likely be with the
      Chunk endpoint.
  - name: Chunk Group
    description: >-
      Chunk groups endpoint. Think of a chunk_group as a bookmark folder within
      the dataset.
  - name: Crawl
    description: Crawl endpoint. Used to create and manage crawls for datasets.
  - name: File
    description: >-
      File endpoint. When files are uploaded, they are stored in S3 and broken
      up into chunks with text extraction from Apache Tika. You can upload files
      of pretty much any type up to 1GB in size. See chunking algorithm details
      at `docs.trieve.ai` for more information on how chunking works. Improved
      default chunking is on our roadmap.
  - name: Events
    description: >-
      Notifications endpoint. Files are uploaded asynchronously and events are
      sent to the user when the upload is complete.
  - name: Topic
    description: >-
      Topic chat endpoint. Think of topics as the storage system for gen-ai chat
      memory. Gen AI messages belong to topics.
  - name: Message
    description: >-
      Message chat endpoint. Messages are units belonging to a topic in the
      context of a chat with a LLM. There are system, user, and assistant
      messages.
  - name: Stripe
    description: >-
      Stripe endpoint. Used for the managed SaaS version of this app. Eventually
      this will become a micro-service. Reach out to the team using contact info
      found at `docs.trieve.ai` for more information.
  - name: Health
    description: Health check endpoint. Used to check if the server is up and running.
  - name: Metrics
    description: Metrics endpoint. Used to get information for monitoring
  - name: Analytics
    description: Analytics endpoint. Used to get information for search and RAG analytics
  - name: Experiment
    description: Experiment endpoint. Used to create and manage experiments
paths:
  /api/message/edit_image:
    post:
      tags:
        - Message
      summary: Edit Image
      description: >-
        Uses `gpt-image-1` to edit an images based on a given prompt. Note that
        the images must be

        base64 encoded and all must have the same mime type.
      operationId: edit_image
      parameters:
        - name: TR-Dataset
          in: header
          description: >-
            The dataset id or tracking_id to use for the request. We assume you
            intend to use an id if the value is a valid uuid.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: JSON request payload to edit an image
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditImageReqPayload'
        required: true
      responses:
        '200':
          description: A list of base64 encoded images
          headers:
            TR-QueryID:
              schema:
                type: string
                format: uuid
              description: Query ID that is used for tracking analytics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageEditResponse'
        '400':
          description: Service error relating to editing the image
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseBody'
      security:
        - ApiKey:
            - admin
components:
  schemas:
    EditImageReqPayload:
      type: object
      required:
        - input_images
        - prompt
      properties:
        input_images:
          type: array
          items:
            $ref: '#/components/schemas/ImageUpload'
          description: The images to edit
        mime_type:
          type: string
          description: The mime type of the uploaded image(s)
          nullable: true
        'n':
          type: integer
          format: int32
          description: 'The number of images to generate (default: 1)'
          nullable: true
          minimum: 0
        prompt:
          type: string
          description: The prompt describing the desired edit
        quality:
          allOf:
            - $ref: '#/components/schemas/InputImageQuality'
          nullable: true
        size:
          allOf:
            - $ref: '#/components/schemas/InputImageSize'
          nullable: true
    ImageEditResponse:
      type: object
      required:
        - image_urls
      properties:
        image_urls:
          type: array
          items:
            type: string
          description: The URL of the generated image
    ErrorResponseBody:
      type: object
      required:
        - message
      properties:
        message:
          type: string
      example:
        message: Bad Request
    ImageUpload:
      type: object
      required:
        - image_src
        - file_name
      properties:
        file_name:
          type: string
          description: The file name of the image
        image_src:
          $ref: '#/components/schemas/ImageSourceType'
    InputImageQuality:
      type: string
      enum:
        - low
        - medium
        - high
    InputImageSize:
      type: string
      enum:
        - 1024x1024
        - 1024x1536
        - 1536x1024
    ImageSourceType:
      oneOf:
        - type: object
          title: Base64
          required:
            - base64
          properties:
            base64:
              type: string
              description: Base64 encoded image data
        - type: object
          title: URL
          required:
            - url
          properties:
            url:
              type: string
              description: URL of the image
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: Authorization

````