---
title: "Convert a Sketch Image to a Real Image"
method: POST
path: "/api/ai/images/modify/v3/sketch-image"
tags: ["AI Services"]
---

# Convert a Sketch Image to a Real Image

`POST /api/ai/images/modify/v3/sketch-image`

## Request

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

Convert a Sketch Image to a Real Image using this endpoint. You can pass in the Sketch Image and we will convert it to a Real Image for you. This is mostly used in cases where you want to convert a Sketch Image to a Real Image. This is mostly used in cases where you want to build a recommendation engine or suggest people based on meaning and emotional ideas.

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

- object
  - `existing_image` string, binary: The image to be modified or edited. Max image size in 1024px`.
  - `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.
  - `description` string: The description of the modification to be applied to the image. You can add in the modification parameters as a string based description.

## 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-03-29** `7d08822be9da`: 1 warning, 1 info
  - removed the optional property `result` from the response with the `200` status
  - added the optional property `image` to the response with the `200` status
- **2024-03-14** `44e6cc2a1f5c`: 1 info
  - endpoint added

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