---
title: "Search and Replace Objects in Image"
method: POST
path: "/api/ai/images/modify/v3/search-replace-image"
tags: ["AI Services"]
---

# Search and Replace Objects in Image

`POST /api/ai/images/modify/v3/search-replace-image`

## Request

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

Utilize this endpoint to search for specific objects within an image and replace them with alternative imagery. This powerful feature supports a wide range of applications, from updating product images in e-commerce settings to modifying elements in marketing materials or personal photos, allowing for creative and dynamic image transformations.

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

- object
  - `existing_image` string, binary: The image to be modified or edited.
  - `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 description of the modification to be applied to the image. This can include instructions or desired outcomes for the image modification process.
  - `search_object` string: The object or element you want to replace the searched object with.

## 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.
- `401`: Unauthorized
- `404`: Not Found
- `406`: Not Acceptable
- `500`: Internal Server Error

## Changes

- **2024-04-03** `04f5ce10626a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/changes/api/ai/images/modify/v3/search-replace-image/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)