Image Eraser
curl --request POST \
--url https://api.highwayapi.ai/v3/async/image-eraser \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
{
"mask": "<string>",
"image": "<string>",
"prompt": "<string>",
"output_format": "<string>"
}
'import requests
url = "https://api.highwayapi.ai/v3/async/image-eraser"
payload = {
"mask": "<string>",
"image": "<string>",
"prompt": "<string>",
"output_format": "<string>"
}
headers = {
"Content-Type": "<content-type>",
"Authorization": "<authorization>"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': '<content-type>', Authorization: '<authorization>'},
body: JSON.stringify({
mask: '<string>',
image: '<string>',
prompt: '<string>',
output_format: '<string>'
})
};
fetch('https://api.highwayapi.ai/v3/async/image-eraser', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.highwayapi.ai/v3/async/image-eraser",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'mask' => '<string>',
'image' => '<string>',
'prompt' => '<string>',
'output_format' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.highwayapi.ai/v3/async/image-eraser"
payload := strings.NewReader("{\n \"mask\": \"<string>\",\n \"image\": \"<string>\",\n \"prompt\": \"<string>\",\n \"output_format\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "<content-type>")
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.highwayapi.ai/v3/async/image-eraser")
.header("Content-Type", "<content-type>")
.header("Authorization", "<authorization>")
.body("{\n \"mask\": \"<string>\",\n \"image\": \"<string>\",\n \"prompt\": \"<string>\",\n \"output_format\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.highwayapi.ai/v3/async/image-eraser")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = '<authorization>'
request.body = "{\n \"mask\": \"<string>\",\n \"image\": \"<string>\",\n \"prompt\": \"<string>\",\n \"output_format\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"task_id": "<string>"
}Images
Image Eraser
POST
/
v3
/
async
/
image-eraser
Image Eraser
curl --request POST \
--url https://api.highwayapi.ai/v3/async/image-eraser \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
{
"mask": "<string>",
"image": "<string>",
"prompt": "<string>",
"output_format": "<string>"
}
'import requests
url = "https://api.highwayapi.ai/v3/async/image-eraser"
payload = {
"mask": "<string>",
"image": "<string>",
"prompt": "<string>",
"output_format": "<string>"
}
headers = {
"Content-Type": "<content-type>",
"Authorization": "<authorization>"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': '<content-type>', Authorization: '<authorization>'},
body: JSON.stringify({
mask: '<string>',
image: '<string>',
prompt: '<string>',
output_format: '<string>'
})
};
fetch('https://api.highwayapi.ai/v3/async/image-eraser', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.highwayapi.ai/v3/async/image-eraser",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'mask' => '<string>',
'image' => '<string>',
'prompt' => '<string>',
'output_format' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.highwayapi.ai/v3/async/image-eraser"
payload := strings.NewReader("{\n \"mask\": \"<string>\",\n \"image\": \"<string>\",\n \"prompt\": \"<string>\",\n \"output_format\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "<content-type>")
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.highwayapi.ai/v3/async/image-eraser")
.header("Content-Type", "<content-type>")
.header("Authorization", "<authorization>")
.body("{\n \"mask\": \"<string>\",\n \"image\": \"<string>\",\n \"prompt\": \"<string>\",\n \"output_format\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.highwayapi.ai/v3/async/image-eraser")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = '<authorization>'
request.body = "{\n \"mask\": \"<string>\",\n \"image\": \"<string>\",\n \"prompt\": \"<string>\",\n \"output_format\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"task_id": "<string>"
}This is an asynchronous API and only returns an asynchronous task_id. You need to use the task_id to call the task result query API to retrieve the image erasing result.
This is an asynchronous API and will only return the task_id of the asynchronous task. You should use this task_id to request the Get Task Result API to retrieve the generated result.
Request Headers
string
required
Enum value:
application/jsonstring
required
Bearer authentication format: Bearer {{API Key}}.
Request Body
string
The mask image used to indicate the area to erase. The area to erase should be white, and the area to keep should be black.
string
required
The original image to generate the image from.
string
A text prompt used to specify the object or area to remove from the image. For example: ‘dog’ or ‘hat’.
string
default:"jpeg"
The format of the output image.Optional values:
jpeg, png, webpResponse Information
string
required
Use task_id to request the Get Task Result API to retrieve the generated output.
⌘I