This api lets you upload your image on assets and use URL for your image input.
New Image URLs
Bad Request
Insufficient Credit
Validation Error
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}
You can generate and download images from your text prompt.
Generate image from text prompt.
import requests
url = "https://api.vimmerse.net/image/text-2-image"
headers = {
'X-Api-Key': 'YOUR_API_KEY',
}
payload = {
"quantity": 3,
"prompt": "Shot of Nike shoes on colorful background.",
"option": "Auto",
"aspect_ratio": "16:9"
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
New Image URLs
Bad Request
Insufficient Credit
Validation Error
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}
You can generate image(s) from base image and text prompt
that describes changes to your base image.
You can upload your base image by using image_file
or put public image URL into image_url
field.
import requests
url = "https://api.vimmerse.net/image/image-2-image"
payload = {
'prompt': 'Make shoe blue and look more real like in the shop.',
'quantity': 2,
'creativity_strength': 3,
'aspect_ratio': '4:3',
'option': 'RealisticVision'
}
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
New Image URLs
Bad Request
Insufficient Credit
Validation Error
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}
You can reimagine uploaded image and text prompt that describes changes to your uploaded image.
import requests
url = "https://api.vimmerse.net/image/reimagine"
payload = {
'prompt': 'Make shoe blue and change wall to sky.',
'aspect_ratio': '16:9',
'option': 'Remake',
'creativity_strength': 3,
}
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
Restructure
option.import requests
url = "https://api.vimmerse.net/image/reimagine"
payload = {
'prompt': 'a well manicured shrub in an english garden',
'aspect_ratio': '16:9',
'creativity_strength': 3,
'option': "Restructure"
}
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
Restyle
option.import requests
url = "https://api.vimmerse.net/image/reimagine"
payload = {
'prompt': 'a majestic portrait of a chicken',
'aspect_ratio': '16:9',
'creativity_strength': 3,
'option': "Restyle"
}
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
Sketch
option.import requests
url = "https://api.vimmerse.net/image/reimagine"
payload = {
'prompt': 'a medieval castle on a hill',
'aspect_ratio': '16:9',
'creativity_strength': 3,
'option': "Sketch"
}
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
ReplaceWith
option.import requests
url = "https://api.vimmerse.net/image/reimagine"
payload = {
'prompt': 'Replace shoe with pepsi.', ## Please make sure prompt contains `replace` and `with`.
'aspect_ratio': '16:9',
'creativity_strength': 3,
'option': "ReplaceWith"
}
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
RecolorTo
option.import requests
url = "https://api.vimmerse.net/image/reimagine"
payload = {
'prompt': 'Recolor green clothes to white clothes.', ## Please make sure prompt contains `recolor` and `to`.
'aspect_ratio': '16:9',
'creativity_strength': 3,
'option': "ReplaceWith"
}
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
New Image URLs
Bad Request
Insufficient Credit
Validation Error
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}
You can generate an image with elements or replace items by prompt.
New Image URLs
Bad Request
Insufficient Credit
Validation Error
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}
You can remove/replace/restyle background from your given image.
import requests
url = "https://api.vimmerse.net/image/replace-background"
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
payload={
"option": "RemoveBackground"
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
import requests
url = "https://api.vimmerse.net/image/replace-background"
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
('image2_file', ('image2.png', open('/path/to/new/background.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
payload={
"option": "ReplaceBackground"
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
import requests
url = "https://api.vimmerse.net/image/replace-background"
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
('image2_file', ('image2.png', open('/path/to/new/background.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
payload={
"option": "RestyleBackground"
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
Modified image url.
Bad Request
Insufficient Credit
Validation Error
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}
You can edit the image with below options. To use reframe, you can use this URL for reference.
import requests
url = "https://api.vimmerse.net/image/edit-image"
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
payload={
"option": "RemoveText"
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
import requests
url = "https://api.vimmerse.net/image/edit-image"
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
payload={
"option": "Upscale"
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
import requests
url = "https://api.vimmerse.net/image/edit-image"
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
payload={
"option": "ExpandToAspectRatio",
"aspect_ratio": "16:9"
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
import requests
url = "https://api.vimmerse.net/image/edit-image"
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
('mask_file', ('mask.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
payload={
"option": "Inpaint",
"prompt": "Add fantastic background image for inpainting.",
"quantity": 1
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
Modified image url.
Bad Request
Insufficient Credit
Validation Error
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}
This api swaps face from base image with new face from second image.
import requests
url = "https://api.vimmerse.net/image/face-swap"
files=[
('image_files',('main_image.png',open('/path/to/your/main_image.png','rb'),'image/png')),
('image_files',('human1_image.jpeg',open('/path/to/your/human_image.jpeg','rb'),'image/jpeg'))
('image_files',('human2_image.jpeg',open('/path/to/your/human_image.jpeg','rb'),'image/jpeg'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
payload = {
order_indices:[0, 1]
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
import requests
url = "https://api.vimmerse.net/image/face-swap"
payload = {
"main_image_url": "https://path.to.your/main_image.png",
"human_image_url": "https://path.to.your/human_image.png",
}
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
New Image URLs
Bad Request
Insufficient Credit
Validation Error
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}
This api generates virtual try on image.
import requests
url = "https://api.vimmerse.net/image/try-on"
files=[
('human_image_file',('human_image.jpeg',open('/path/to/your/human_image.jpeg','rb'),'image/jpeg')),
('clothes_image_file',('clothes_image.jpeg',open('/path/to/your/clothes_image.jpeg','rb'),'image/jpeg'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
import requests
url = "https://api.vimmerse.net/image/try-on"
payload = {
"human_image_url": "https://path.to.your/human_image.png",
"clothes_image_url": "https://path.to.your/clothes_image.png",
}
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
New Image URLs
Bad Request
Insufficient Credit
Validation Error
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}
Image Stylization transforms images into stunning artworks with various artistic styles. Available styles are "3d", "realistic_style", "angel", "anime_style", "japanese_comics", "princess_style", "dreamy", "ink_style", "new_monet_garden", "monets_garden", "exquisite_comic", "cyber_machinery", "chinese_style", "romantic", "ugly_clay", "cute_doll", "3d_gaming", "animated_movie" and "doll".
Generate text prompt from image. import requests
url = "https://api.vimmerse.net/image/restyle"
payload = {
'style': 'anime_style'
}
files=[
('image_file', ('image.png', open('/path/to/image.png','rb'), 'image/png'))
]
headers = {
'X-Api-Key': 'YOUR_API_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
New Image URLs
Bad Request
Insufficient Credit
Validation Error
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}