Replace Background

For more detailed information on the workings of this model, please refer to the Replace Background page.

Replace Background API

POST /getImagetoImage

Headers

Name Value

Name	Value
Content-Type	`application/json`
Authorization	`Bearer <token>`

Content-Type

application/json

Authorization

Bearer <token>

Body

Name Type Description

Name	Type	Description
app_id	string	-> Each model is uniquely characterized by its own `app_id`.
image	string	-> The `image` parameter specifies the URL of an existing image that will be used as a reference for the generation process. -> If the original image dimensions exceed 1536x1536 pixels, the image will be adjusted to fit within this size while preserving the original aspect ratio.
prompt	string	-> The `prompt` parameter is the textual input that guides the image generation process. This prompt serves as an artistic compass, shaping the visual output.
batch	int	-> The `batch` parameter allows you to specify the number of images to generate at once. -> The valid range for this parameter is between 1 and 8.
negative_prompt	string	-> The `negative_prompt` parameter allows you to specify content that you want the image generation model to avoid or minimize in the output. This can be useful for excluding certain visual elements or styles that you do not want to be present in the generated image.
celery	bool	-> The `celery` parameter is used for queuing tasks that require extended processing time. When you enqueue a task, you receive a unique `task_id`. This `task_id` allows you to check the task's status later using the task status API, which is useful for managing and tracking long-running tasks.

app_id

string

-> Each model is uniquely characterized by its own app_id.

image

string

-> The image parameter specifies the URL of an existing image that will be used as a reference for the generation process.

-> If the original image dimensions exceed 1536x1536 pixels, the image will be adjusted to fit within this size while preserving the original aspect ratio.

prompt

string

-> The prompt parameter is the textual input that guides the image generation process. This prompt serves as an artistic compass, shaping the visual output.

batch

int

-> The batch parameter allows you to specify the number of images to generate at once.

-> The valid range for this parameter is between 1 and 8.

negative_prompt

string

-> The negative_prompt parameter allows you to specify content that you want the image generation model to avoid or minimize in the output. This can be useful for excluding certain visual elements or styles that you do not want to be present in the generated image.

celery

bool

-> The celery parameter is used for queuing tasks that require extended processing time. When you enqueue a task, you receive a unique task_id. This task_id allows you to check the task's status later using the task status API, which is useful for managing and tracking long-running tasks.

Response

{
  "time_required": "",
  "error": "",
  "error_data": "",
  "input": "",
  "output": "",
  "app_id": "",
  "task_id": "",
  "status": ""
}

Run the API

To test this API, please use the following link:

https://app.theneo.io/api-runner/qolaba/ml-apis/api-reference/replace-background

PreviousInpainting NextFace Consistency

Last updated 6 months ago