API Reference
Edit images using prompt and mask
POST
/
v1
/
images
/
edits
Edit images using prompt and mask
curl --request POST \
--url https://api.synapsai.cloud/v1/images/edits \
--header 'Content-Type: multipart/form-data' \
--form 'image=<string>' \
--form 'mask=<string>' \
--form 'prompt=<string>' \
--form 'negative_prompt=<string>' \
--form n=1 \
--form output_format=png \
--form response_format=url \
--form 'size=<string>' \
--form blur_factor=123 \
--form padding_mask_crop=123 \
--form strength=0.5 \
--form seed=123 \
--form num_inference_steps=50 \
--form guidance_scale=7.5import requests
url = "https://api.synapsai.cloud/v1/images/edits"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mask\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prompt\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"negative_prompt\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"n\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format\"\r\n\r\npng\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"response_format\"\r\n\r\nurl\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"size\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"blur_factor\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"padding_mask_crop\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"strength\"\r\n\r\n0.5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"seed\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"num_inference_steps\"\r\n\r\n50\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"guidance_scale\"\r\n\r\n7.5\r\n-----011000010111000001101001--"
headers = {"Content-Type": "multipart/form-data"}
response = requests.post(url, data=payload, headers=headers)
print(response.text){
"model": "<string>",
"created": 123,
"id": "<string>",
"data": [
{
"url": "<string>",
"b64_json": "<string>"
}
],
"size": "<string>",
"output_format": "<string>"
}Body
multipart/form-dataapplication/json
Image file format for outputs.
Available options:
png, jpeg, webp Response format for image endpoints.
Available options:
url, b64_json ⌘I
Edit images using prompt and mask
curl --request POST \
--url https://api.synapsai.cloud/v1/images/edits \
--header 'Content-Type: multipart/form-data' \
--form 'image=<string>' \
--form 'mask=<string>' \
--form 'prompt=<string>' \
--form 'negative_prompt=<string>' \
--form n=1 \
--form output_format=png \
--form response_format=url \
--form 'size=<string>' \
--form blur_factor=123 \
--form padding_mask_crop=123 \
--form strength=0.5 \
--form seed=123 \
--form num_inference_steps=50 \
--form guidance_scale=7.5import requests
url = "https://api.synapsai.cloud/v1/images/edits"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mask\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prompt\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"negative_prompt\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"n\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format\"\r\n\r\npng\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"response_format\"\r\n\r\nurl\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"size\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"blur_factor\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"padding_mask_crop\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"strength\"\r\n\r\n0.5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"seed\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"num_inference_steps\"\r\n\r\n50\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"guidance_scale\"\r\n\r\n7.5\r\n-----011000010111000001101001--"
headers = {"Content-Type": "multipart/form-data"}
response = requests.post(url, data=payload, headers=headers)
print(response.text){
"model": "<string>",
"created": 123,
"id": "<string>",
"data": [
{
"url": "<string>",
"b64_json": "<string>"
}
],
"size": "<string>",
"output_format": "<string>"
}