Generative Fill API

POST

https://api.vyro.ai/v2/image/edits/generative-fill

image

This API endpoint allows you to perform inpainting, where a masked region of an image is filled in based on a text prompt and other parameters. The response will contain the edited image with the inpainted section.

Request

Header Params

Authorization

string

required

A bearer token that authenticates the user for making the request.

Example:

Bearer {{API Token}}

Body Params multipart/form-data

prompt

string

required

A text description that guides the inpainting process. The image will be modified to align with this prompt in the masked areas.

Example:

A peaceful autumn scene with vibrant orange, red, and gold leaves scattered across the ground

image

file

required

The image file to be edited.

Example:

cmMtdXBsb2FkLTE3MzI3OTQ1ODg4NzktNQ==/camera.jpg

mask

file

required

The mask image indicating the areas to be inpainted. Mask should have same dimensions as the input image.

Example:

cmMtdXBsb2FkLTE3MzI3OTQ1ODg4NzktNw==/camerasmallmask.png

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.vyro.ai/v2/image/edits/generative-fill' \
--header 'Authorization: Bearer vk-ad08a8e86d1a84404e5837be47d39ab44474f982671c0a' \
--form 'prompt="A peaceful autumn scene with vibrant orange, red, and gold leaves scattered across the ground"' \
--form 'image=@"cmMtdXBsb2FkLTE3MzI3OTQ1ODg4NzktNQ==/camera.jpg"' \
--form 'mask=@"cmMtdXBsb2FkLTE3MzI3OTQ1ODg4NzktNw==/camerasmallmask.png"'

Responses

🟢200Success

application/octet-stream

If the request is successful, the API will return the generated image file.

Body

object {0}

Example

The response for 200 code is bytes.

🟠400Bad Request

🔴500Internal Server Error

🔴503Service Unavailable

🟠400Bad Request

🟢200Success

🔴500Internal Server Error

🔴503Service Unavailable

Modified at 2024-11-29 10:44:21

Image Upscale API

AI Resize API