DEdevflowinc
Message

Edit Image

Changed on

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.

post/api/message/edit_image

Request

  • Base URL
    https://api.trieve.ai
  • URL
    https://api.trieve.ai/api/message/edit_image
  • Auth
    API key in header Authorization

Headers

TR-Datasetstring uuid required

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.

Request body

mime_typestring nullable

The mime type of the uploaded image(s)

ninteger nullable

The number of images to generate (default: 1)

promptstring required

The prompt describing the desired edit

quality'low' | 'medium' | 'high'
size'1024x1024' | '1024x1536' | '1536x1024'

Response

A list of base64 encoded images

image_urlsstring[] required

The URL of the generated image

Changes

  • f86adcbeb66dRevision changes
    • breaking

      added the new required request property //

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property //

    • info

      added the required property to the response with the status

  • 216ae1603310Revision changes
    • info

      added the media type application/json for the response with the status