---
title: "Modify existing image using ImageCon V2"
method: POST
path: "/api/ai/images/modify/v2"
tags: ["AI Services"]
---

# Modify existing image using ImageCon V2

`POST /api/ai/images/modify/v2`

## Request

- Base URL: `https://api.worqhat.com`
- URL: `https://api.worqhat.com/api/ai/images/modify/v2`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/docs/api/ai/images/modify/v2/post.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint is used to modify an existing image using AI. It accepts a Form Data containing the image modification parameters and returns the modified image.

## Request body `multi-part/form-data`

- object
  - `existing_image` string, binary: The image to be modified or edited. Neither `height` nor `width` of the image should be less than `128px`. Only one of the sides of the image should be greater than or equal to `512px`. (Eg: `512x512`, `512x768`, `768x512`). Maximum dimensions supported is `512x896`
  - `output_type` 'url' | 'blob': The type of output to be generated. You can choose between `url` and `blob` . `URL` will return a cloud-hosted Temporary URL for the generated image, you need to handle the image download on your end. `blob` will return the image as a base64 encoded string.
  - `modification` string: The modification to be applied to the image. You can add in the modification parameters as a string based description.
  - `similarity` number: The similarity to be applied to the image. It is a number between 0 and 100. The higher the number, the more similar the image will be to the original.

## Response `200`

Image generated successfully

- object
  - `status` string: Status indicating the success of the image generation.
  - `image` string: The generated image.
  - `processing_time` integer: The time taken to process the request, in milliseconds.
  - `processing_id` string: A universally unique identifier for the request. This can be used to track the request in the logs.
  - `processing_count` integer: The number of times the request has been processed. This is what is considered in the Billing Process. This is either the number of times the image is processed or the number of words that the server processes.

## Other responses

- `400`: Bad Request. This mostly happens because of invalid image sizes. Neither `height` nor `width` of the image should be less than 128px. Only one of the sides of the image should be greater than or equal to 512px. (Eg: 512x512, 512x768, 768x512) Maximum dimensions supported is 512x896.
- `401`: Unauthorized
- `404`: Not Found
- `406`: Not Acceptable
- `500`: Internal Server Error

## Changes

- **2023-10-20** `871850b7231f`: 1 breaking, 3 warning, 17 info
  - removed the media type `multipart/form-data` from the request body
  - removed the optional property `content` from the response with the `200` status
  - removed the optional property `id` from the response with the `200` status
  - removed the optional property `timestamp` from the response with the `200` status
  - …17 more
- **2023-08-15** `b5ffe2a9748f`: 6 breaking, 17 info
  - the response's body type changed from no type to `object` for status `200`
  - the response's body type changed from no type to `object` for status `400`
  - the response's body type changed from no type to `object` for status `401`
  - the response's body type changed from no type to `object` for status `404`
  - …19 more
- **2023-08-04** `be85a8f8fc8c`: 6 breaking, 15 warning
  - the response's body type changed from `object` to no type for status `200`
  - the response's body type changed from `object` to no type for status `400`
  - the response's body type changed from `object` to no type for status `401`
  - the response's body type changed from `object` to no type for status `404`
  - …17 more
- **2023-08-04** `d6dbf089e00d`: 1 info
  - the endpoint scheme security `bearerAuth` was removed from the API
- **2023-08-03** `87a2697d00bf`: 2 info
  - the endpoint scheme security `bearerAuth` was added to the API
  - the endpoint scheme security `ApiKeyAuth AND OrgKeyAuth` was removed from the API

[Operation history](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/changes/api/ai/images/modify/v2/post.md)

---

[API](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2.md) - [All operations](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/llms.txt) - [OpenAPI document](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/revisions/fc369f69a3e6?raw)