POST
/
api
/
ai
/
images
/
modify
/
v2
Authorization
Body
curl --request POST \
  --url https://api.worqhat.com/api/ai/images/modify/v2 \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: multi-part/form-data' \
  --data '{
  "existing_image": "/path/to/image.jpg",
  "modification": "Add a cat to the image",
  "output_type": "url",
  "similarity": 50
}'
{
  "image": "https://storage.googleapis.com/1fe0a9ac-617a-42e4-a376-37808b98fc99-worqhat/image-gen/MFl2oNxrMLYKvWbwoDkbQPpScWD3-1697226444718.png?GoogleAccessId=cloud-storage-upload%40worqhat-dev.iam.gserviceaccount.com&Expires=1697226626&Signature=DHlOeWd4QladLc6hsdoqp9lTbvMXs06B6hOkQPviFubszuLfahXXRv9aj%2FPTTlytlTClXHX0zGFr3Tsq9S%2Fs3hFjqBsy7lho%2BfuRFhPG4FrQoV2lxrZmB47X6nWc7TG6hbgLkyT3CvAOfwccmWHH1cbBiEDSI0iEKvx7kwUsgIrYu1ko9Szkul29fjVQ89WL6jyQQX1G9ejsQTNmXHFNRvhwRHkRfZJ5n3Y1uR7aqAyMZfQ2Me6i7bVb7smc0t5Ed2yk6%2BN1fdrz6zhbkc%2Fuh13vWhrT8EWMuCYKhsrzPakO%2B%2B229nlt5Y4D9zyFqevAmj43Vl76INIq29gcs39oQg%3D%3D",
  "processing_count": 2,
  "processing_id": "cd185dd4-fcfb-4b15-93de-db9eded23ade",
  "processing_time": 2311,
  "status": "success"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multi-part/form-data
existing_image
string

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

modification
string

The modification to be applied to the image. You can add in the modification parameters as a string based description.

output_type
enum<string>

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.

Available options:
url,
blob
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 - application/json
image
string

The generated image.

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.

processing_id
string

A universally unique identifier for the request. This can be used to track the request in the logs.

processing_time
integer

The time taken to process the request, in milliseconds.

status
string

Status indicating the success of the image generation.

Was this page helpful?

ImageCon V3 BetaImage to Image Generation V3