curl --request POST \
--url https://api.developer.pixelcut.ai/v1/generate-background \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"image_url": "https://cdn3.pixelcut.app/product.jpg",
"image_transform": {
"scale": 1,
"x_center": 0.5,
"y_center": 0.5
},
"prompt": "<string>",
"negative_prompt": "<string>"
}
'import requests
url = "https://api.developer.pixelcut.ai/v1/generate-background"
payload = {
"image_url": "https://cdn3.pixelcut.app/product.jpg",
"image_transform": {
"scale": 1,
"x_center": 0.5,
"y_center": 0.5
},
"prompt": "<string>",
"negative_prompt": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
image_url: 'https://cdn3.pixelcut.app/product.jpg',
image_transform: {scale: 1, x_center: 0.5, y_center: 0.5},
prompt: '<string>',
negative_prompt: '<string>'
})
};
fetch('https://api.developer.pixelcut.ai/v1/generate-background', 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.developer.pixelcut.ai/v1/generate-background",
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([
'image_url' => 'https://cdn3.pixelcut.app/product.jpg',
'image_transform' => [
'scale' => 1,
'x_center' => 0.5,
'y_center' => 0.5
],
'prompt' => '<string>',
'negative_prompt' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.developer.pixelcut.ai/v1/generate-background"
payload := strings.NewReader("{\n \"image_url\": \"https://cdn3.pixelcut.app/product.jpg\",\n \"image_transform\": {\n \"scale\": 1,\n \"x_center\": 0.5,\n \"y_center\": 0.5\n },\n \"prompt\": \"<string>\",\n \"negative_prompt\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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.developer.pixelcut.ai/v1/generate-background")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"image_url\": \"https://cdn3.pixelcut.app/product.jpg\",\n \"image_transform\": {\n \"scale\": 1,\n \"x_center\": 0.5,\n \"y_center\": 0.5\n },\n \"prompt\": \"<string>\",\n \"negative_prompt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.developer.pixelcut.ai/v1/generate-background")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"image_url\": \"https://cdn3.pixelcut.app/product.jpg\",\n \"image_transform\": {\n \"scale\": 1,\n \"x_center\": 0.5,\n \"y_center\": 0.5\n },\n \"prompt\": \"<string>\",\n \"negative_prompt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"result_url": "https://assets.pixelcut.app/public/result/a16646be-91c8-4e3a-b359.jpg"
}{
"error": "File size too large",
"error_code": "file_size_too_large"
}{
"error": "API Token not found",
"error_code": "invalid_auth_token"
}{
"error": "Insufficient credits available",
"error_code": "insufficient_api_credits"
}{
"error": "Too many requests",
"error_code": "rate_limit_exceeded"
}Generate Background
Generates a new background for an image. Generated images are 1024x1024 by default.
Input Image Limits:
- Max size: 25MB
- Min resolution: 64x64px
- Max resolution: 6000x6000px
curl --request POST \
--url https://api.developer.pixelcut.ai/v1/generate-background \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"image_url": "https://cdn3.pixelcut.app/product.jpg",
"image_transform": {
"scale": 1,
"x_center": 0.5,
"y_center": 0.5
},
"prompt": "<string>",
"negative_prompt": "<string>"
}
'import requests
url = "https://api.developer.pixelcut.ai/v1/generate-background"
payload = {
"image_url": "https://cdn3.pixelcut.app/product.jpg",
"image_transform": {
"scale": 1,
"x_center": 0.5,
"y_center": 0.5
},
"prompt": "<string>",
"negative_prompt": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
image_url: 'https://cdn3.pixelcut.app/product.jpg',
image_transform: {scale: 1, x_center: 0.5, y_center: 0.5},
prompt: '<string>',
negative_prompt: '<string>'
})
};
fetch('https://api.developer.pixelcut.ai/v1/generate-background', 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.developer.pixelcut.ai/v1/generate-background",
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([
'image_url' => 'https://cdn3.pixelcut.app/product.jpg',
'image_transform' => [
'scale' => 1,
'x_center' => 0.5,
'y_center' => 0.5
],
'prompt' => '<string>',
'negative_prompt' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.developer.pixelcut.ai/v1/generate-background"
payload := strings.NewReader("{\n \"image_url\": \"https://cdn3.pixelcut.app/product.jpg\",\n \"image_transform\": {\n \"scale\": 1,\n \"x_center\": 0.5,\n \"y_center\": 0.5\n },\n \"prompt\": \"<string>\",\n \"negative_prompt\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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.developer.pixelcut.ai/v1/generate-background")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"image_url\": \"https://cdn3.pixelcut.app/product.jpg\",\n \"image_transform\": {\n \"scale\": 1,\n \"x_center\": 0.5,\n \"y_center\": 0.5\n },\n \"prompt\": \"<string>\",\n \"negative_prompt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.developer.pixelcut.ai/v1/generate-background")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"image_url\": \"https://cdn3.pixelcut.app/product.jpg\",\n \"image_transform\": {\n \"scale\": 1,\n \"x_center\": 0.5,\n \"y_center\": 0.5\n },\n \"prompt\": \"<string>\",\n \"negative_prompt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"result_url": "https://assets.pixelcut.app/public/result/a16646be-91c8-4e3a-b359.jpg"
}{
"error": "File size too large",
"error_code": "file_size_too_large"
}{
"error": "API Token not found",
"error_code": "invalid_auth_token"
}{
"error": "Insufficient credits available",
"error_code": "insufficient_api_credits"
}{
"error": "Too many requests",
"error_code": "rate_limit_exceeded"
}Authorizations
All API requests require a valid api key. Include your token as a HTTP request header in the following format: X-API-Key: skXXXXXXXXXXXXXXXX. You can obtain an api key by signing up for developer access in your Pixelcut account.
Headers
Acceptable response media type(s). application/json or image/*. Default is application/json.
Body
URL of the image. If the image is RGB the background will automatically be removed, if the image is RGBA the background will not be removed and the alpha channel will be respected.
"https://cdn3.pixelcut.app/product.jpg"
Show child attributes
Show child attributes
Select a preset scene type. If provided prompt and negative_prompt will be ignored.
marble, wood, industrial, linen, brick, counter A description of the desired scene used to guide the image generation process.
A comma seperated list of attributes which should be discouraged in the image generation.
Response
Success
A URL to access the resultant image which is valid for 1 hour. File format will be jpeg.
"https://assets.pixelcut.app/public/result/a16646be-91c8-4e3a-b359.jpg"