POST
/
api
/
beta
/
generate
/
image-to-image

Authorizations

Authorization
string
headerrequired

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

Body

multipart/form-data
prompt
string
required

Text prompt(s) to guide image generation.

image
file
required

Uploaded image to modify with the pipeline.

model_id
string
default: timbrooks/instruct-pix2pix

Hugging Face model ID used for image generation.

strength
number
default: 0.8

Degree of transformation applied to the reference image (0 to 1).

guidance_scale
number
default: 7.5

Encourages model to generate images closely linked to the text prompt (higher values may reduce image quality).

image_guidance_scale
number
default: 1.5

Degree to which the generated image is pushed towards the initial image.

negative_prompt
string
default:

Text prompt(s) to guide what to exclude from image generation. Ignored if guidance_scale < 1.

safety_check
boolean
default: true

Perform a safety check to estimate if generated images could be offensive or harmful.

seed
integer

Seed for random number generation.

num_inference_steps
integer
default: 100

Number of denoising steps. More steps usually lead to higher quality images but slower inference. Modulated by strength.

num_images_per_prompt
integer
default: 1

Number of images to generate per prompt.

Response

200 - application/json

Response model for image generation.

images
object[]
required

The generated images.