Alter Image | Notion

Overview

Alter-Image is an advanced feature that allows users to modify an existing image based on the supplied text input. It employs the latest AI algorithms to turn your textual ideas into visual modifications of your images.

API Documentation

Endpoint Details

Endpoint: https://api.vyro.ai/v1/imagine/api**/generations/guided**

Method: POST

Request Format: Requests must be sent as multipart/form-data to successfully send the image file along with the other data.

Request Parameters

The API accepts the following parameters:

Parameter	Type	Description	Default	Range / Values	Optional
prompt	String	The text prompt describing the desired alteration for the image.	-	-	No
image	Uploadfile	The image file to be altered.	-	-	No
style_id	Integer	The ID of the style to apply to the image.	1	-	Yes
neg_prompt	String	A negative prompt to provide a contrasting effect.	' '	-	Yes
aspect_ratio	String	The desired aspect_ratio of the altered image.	`1:1`	`1:1, 4:3, 3:4, 3:2, 2:3, 16:9 , 9:16, 5:4, 4:5,
8:10, 3:1`	Yes
seed	Integer	A seed value for randomization.	Random	-	Yes
steps	Integer	The number of steps for the alteration process.	`20`	-	Yes
generation_bias	Float	A bias factor that tilts output image with respect to text prompt.	`1.2`	`0.2 - 1.2`	Yes
artistic_noise	Float	The amount of artistic noise to apply to the image.	`0.2`	`0.1 - 0.2`	Yes
aesthetics_weight	Float	A weight parameter determining the trade-off between accuracy and aesthetics.	`0.6`	`0.4 - 1.0`	Yes

Headers

The following keys and values must be included in the request headers:

API Authentication Token: An API token will be provided to the user for authenticating API requests on web, iOS, and Android platforms respectively.

Response Format

The endpoint responds with the altered image file.

Response Status

The status code of the response can be:

Status Code	Reason
200	Success: The request was successful, and the image was altered as expected.
400	Bad Request: The request is malformed or incomplete.
401	Unauthorized: Authentication is required or has failed.
429	Too Many Requests: The user has sent too many requests in a given amount of time.
500	Internal Server Error: An unexpected condition was encountered.

Example Request

Here is an example of how your request might look: