API para eliminar el fondo de imágenes de Pixian

Pixian.AI ofrece una API integral para la eliminación del fondo de imágenes. La API elimina el fondo de imágenes completa y automáticamente y con fidelidad de la más alta calidad.

Obtener la clave de la API

Inicio rápido

Cargue una imagen de mapa de bits y obtenga un resultado con el fondo eliminado:

$ curl https://api.pixian.ai/api/v2/remove-background \
 -u xyz123:[secret] \
 -F image=@example.jpeg \
 -o pixian_result.png
// Requires: org.apache.httpcomponents.client5:httpclient5-fluent

Request request = Request.post("https://api.pixian.ai/api/v2/remove-background")
   .addHeader("Authorization", "Basic cHh4YmJ6Yjk2bjJ3OGFtOltzZWNyZXRd")
   .body(
      MultipartEntityBuilder.create()
         .addBinaryBody("image", new File("example.jpeg")) // TODO: Replace with your image
         // TODO: Add more upload parameters here
         .build()
      );
ClassicHttpResponse response = (ClassicHttpResponse) request.execute().returnResponse();

if (response.getCode() == 200) {
   // Write result to disk, TODO: or wherever you'd like
   try (FileOutputStream out = new FileOutputStream("pixian_result.png")) {
      response.getEntity().writeTo(out);
   }
} else {
   System.out.println("Request Failed: Status: " + response.getCode() + ", Reason: " + response.getReasonPhrase());
}
using (var client = new HttpClient())
using (var form = new MultipartFormDataContent())
{
   client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", "INSERT_API_KEY_HERE");
   form.Add(new ByteArrayContent(File.ReadAllBytes("example.jpeg")), "image", "example.jpeg"); // TODO: Replace with your image
   // TODO: Add more upload parameters here

   var response = client.PostAsync("https://api.pixian.ai/api/v2/remove-background", form).Result;

   if (response.IsSuccessStatusCode)
   {
      // Write result to disk, TODO: or wherever you'd like
      FileStream outStream = new FileStream("pixian_result.png", FileMode.Create, FileAccess.Write, FileShare.None);
      response.Content.CopyToAsync(outStream).ContinueWith((copyTask) => { outStream.Close(); });
   }
   else
   {
       Console.WriteLine("Request Failed: Status: " + response.StatusCode + ", Reason: " + response.ReasonPhrase);
   }
}
// Requires "request" to be installed (see https://www.npmjs.com/package/request)
var request = require('request');
var fs = require('fs');

request.post({
  url: 'https://api.pixian.ai/api/v2/remove-background',
  formData: {
    image: fs.createReadStream('example.jpeg'), // TODO: Replace with your image
    // TODO: Add more upload options here
  },
  auth: {user: 'xyz123', pass: '[secret]'},
  followAllRedirects: true,
  encoding: null
}, function(error, response, body) {
  if (error) {
    console.error('Request failed:', error);
  } else if (!response || response.statusCode != 200) {
    console.error('Error:', response && response.statusCode, body.toString('utf8'));
  } else {
    // Save result
    fs.writeFileSync("pixian_result.png", body);
  }
});
$ch = curl_init('https://api.pixian.ai/api/v2/remove-background');

curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER,
    array('Authorization: Basic cHh4YmJ6Yjk2bjJ3OGFtOltzZWNyZXRd'));
curl_setopt($ch, CURLOPT_POSTFIELDS,
    array(
      'image' => curl_file_create('example.jpeg'),
      // TODO: Add more upload options here
    ));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) == 200) {
  // Save result
  file_put_contents("pixian_result.png", $data);
} else {
  echo "Error: " . $data;
}
curl_close($ch);
# Requires "requests" to be installed (see https://pypi.org/project/requests/)
import requests

response = requests.post(
    'https://api.pixian.ai/api/v2/remove-background',
    files={'image': open('example.jpeg', 'rb')},
    data={
        # TODO: Add more upload options here
    },
    auth=('xyz123', '[secret]')
)
if response.status_code == requests.codes.ok:
    # Save result
    with open('pixian_result.png', 'wb') as out:
        out.write(response.content)
else:
    print("Error:", response.status_code, response.text)
# Requires: gem install httpclient
require 'httpclient'

client = HTTPClient.new default_header: {
  "Authorization" => "Basic cHh4YmJ6Yjk2bjJ3OGFtOltzZWNyZXRd"
}

response = client.post("https://api.pixian.ai/api/v2/remove-background", {
  "image" => File.open("example.jpeg", "rb"), # TODO: Replace with your image
  # TODO: Add more upload parameters here
})

if response.status == 200 then
  # Write result to disk, TODO: or wherever you'd like
  File.open("pixian_result.png", 'w') { |file| file.write(response.body) }
else
  puts "Error: Code: " + response.status.to_s + ", Reason: " + response.reason
end
$ curl https://api.pixian.ai/api/v2/remove-background \
 -u xyz123:[secret] \
 -F 'image.url=https://example.com/example.jpeg' \
 -o pixian_result.png
// Requires: org.apache.httpcomponents.client5:httpclient5-fluent

Request request = Request.post("https://api.pixian.ai/api/v2/remove-background")
   .addHeader("Authorization", "Basic cHh4YmJ6Yjk2bjJ3OGFtOltzZWNyZXRd")
   .body(
      MultipartEntityBuilder.create()
         .addTextBody("image.url", "https://example.com/example.jpeg") // TODO: Replace with your image URL
         // TODO: Add more upload parameters here
         .build()
      );
ClassicHttpResponse response = (ClassicHttpResponse) request.execute().returnResponse();

if (response.getCode() == 200) {
   // Write result to disk, TODO: or wherever you'd like
   try (FileOutputStream out = new FileOutputStream("pixian_result.png")) {
      response.getEntity().writeTo(out);
   }
} else {
   System.out.println("Request Failed: Status: " + response.getCode() + ", Reason: " + response.getReasonPhrase());
}
using (var client = new HttpClient())
using (var form = new MultipartFormDataContent())
{
   client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", "INSERT_API_KEY_HERE");
   form.Add(new StringContent("https://example.com/example.jpeg"), "image.url"); // TODO: Replace with your image URL
   // TODO: Add more upload parameters here

   var response = client.PostAsync("https://api.pixian.ai/api/v2/remove-background", form).Result;

   if (response.IsSuccessStatusCode)
   {
      // Write result to disk, TODO: or wherever you'd like
      FileStream outStream = new FileStream("pixian_result.png", FileMode.Create, FileAccess.Write, FileShare.None);
      response.Content.CopyToAsync(outStream).ContinueWith((copyTask) => { outStream.Close(); });
   }
   else
   {
       Console.WriteLine("Request Failed: Status: " + response.StatusCode + ", Reason: " + response.ReasonPhrase);
   }
}
// Requires "request" to be installed (see https://www.npmjs.com/package/request)
var request = require('request');
var fs = require('fs');

request.post({
  url: 'https://api.pixian.ai/api/v2/remove-background',
  formData: {
    'image.url': 'https://example.com/example.jpeg', // TODO: Replace with your image
    // TODO: Add more upload options here
  },
  auth: {user: 'xyz123', pass: '[secret]'},
  followAllRedirects: true,
  encoding: null
}, function(error, response, body) {
  if (error) {
    console.error('Request failed:', error);
  } else if (!response || response.statusCode != 200) {
    console.error('Error:', response && response.statusCode, body.toString('utf8'));
  } else {
    // Save result
    fs.writeFileSync("pixian_result.png", body);
  }
});
$ch = curl_init('https://api.pixian.ai/api/v2/remove-background');

curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER,
    array('Authorization: Basic cHh4YmJ6Yjk2bjJ3OGFtOltzZWNyZXRd'));
curl_setopt($ch, CURLOPT_POSTFIELDS,
    array(
      'image.url' => 'https://example.com/example.jpeg',
      // TODO: Add more upload options here
    ));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) == 200) {
  // Save result
  file_put_contents("pixian_result.png", $data);
} else {
  echo "Error: " . $data;
}
curl_close($ch);
# Requires "requests" to be installed (see https://pypi.org/project/requests/)
import requests

response = requests.post(
    'https://api.pixian.ai/api/v2/remove-background',
    data={
        'image.url': 'https://example.com/example.jpeg',
        # TODO: Add more upload options here
    },
    auth=('xyz123', '[secret]')
)
if response.status_code == requests.codes.ok:
    # Save result
    with open('pixian_result.png', 'wb') as out:
        out.write(response.content)
else:
    print("Error:", response.status_code, response.text)
# Requires: gem install httpclient
require 'httpclient'

client = HTTPClient.new default_header: {
  "Authorization" => "Basic cHh4YmJ6Yjk2bjJ3OGFtOltzZWNyZXRd"
}

response = client.post("https://api.pixian.ai/api/v2/remove-background", {
  "image.url" => "https://example.com/example.jpeg", # TODO: Replace with your image URL
  # TODO: Add more upload parameters here
})

if response.status == 200 then
  # Write result to disk, TODO: or wherever you'd like
  File.open("pixian_result.png", 'w') { |file| file.write(response.body) }
else
  puts "Error: Code: " + response.status.to_s + ", Reason: " + response.reason
end

¿Está inmigrando desde otro proveedor? Check out our migration guide

Precios

La integración y prueba de la API es gratis. No requiere una compra.

Simplemente use el código test=true para el desarrollo. Puede ver la calidad del resultado usando la aplicación Web interactiva en la página inicial.

Los resultados de la producción requieren la compra de un paquete de créditos. Consulte la página de precios.

Autenticación y seguridad

La API usa autenticación de acceso básico a HTTP estándar. Todas las peticiones a la API se harán en HTTPS e incluirán su información de acceso a la API, donde la Id de la API es el usuario y el código secreto de la API es la contraseña.

Su biblioteca cliente de http debe ser compatible con la Indicación de nombre del servidor (SNI) para poder hacer peticiones. Si tiene errores raros de protocolo de enlace, esta es la razón más probable.

Limitaciones de la velocidad de respuesta

El uso de la API tiene limitaciones de velocidad de respuesta con amplias asignaciones sin límite superior.

Durante la operación normal impulsada por el usuario es improbable que vea límites de la velocidad de respuesta ya que en ese caso el uso tiende a fluir de una manera que el servicio maneja muy bien.

Sin embargo, para los procesos en lotes recomendamos que comience con 5 hilos máximo y puede agregar 1 hilo nuevo cada 5 minutos hasta que llegue al nivel deseado de paralelismo. Si necesita más de 100 hilos actuales, comuníquese con nosotros antes de comenzar.

Si envía demasiadas peticiones comenzará a recibir la respuesta 429 Too Many Requests. Si esto sucede, debe aplicar una espera lineal: cuando reciba la primera respuesta de ese tipo, espere 5 segundos antes de enviar la siguiente petición. Cuando reciba la segunda respuesta 429 consecutiva, espere 2*5=10 segundos antes de enviar la siguiente petición. Cuando reciba la tercera respuesta, espere 3*5=15, etc.

Puede restablecer el contador de espera después de una petición exitosa y deberá poder aplicar la espera por cada hilo (es decir, los hilos deben operar de manera independiente entre sí).

Tiempos de espera

Si bien las peticiones de las API normalmente se completan en segundos, es posible que durante situaciones transitorias de cargas pico el tiempo de procesamiento sea más largo.

Para asegurarse de que la biblioteca de su cliente no suspenda prematuramente las peticiones de la API, se deberá configurar con un tiempo de espera de inactividad de por lo menos 180 segundos.

Error de objeto JSON

Usamos estratos convencionales de HTTP para indicar el éxito o el fracaso de una petición API e incluímos información importante del error en el objeto de error JSON devuelto.

Tratamos de siempre regresar un objeto de error JSON con las solicitudes problemáticas. Sin embargo, siempre es teóricamente posible tener fallas del servidor interno que conducen a una respuesta de error que no es tipo JSON.

Atributos

statusEl estado HTTP de la respuesta, se repite aquí para ayudarle con la depuración.
codeCódigo de error interno de Pixian.AI.
messageMensaje de error en lenguaje natural, previsto para ayudar con la depuración.

Si el estadeo del HTTP de su petición es 200, no se devolverá un objeto JSON de error y podrá suponer en términos generales que la petición tuvo éxito.

Algunas bibliotecas de clientes HTTP producen exepciones para estratos HTTP en la gama de 400-599. Tendrá que darse cuenta de esas excepciones y resolverlas apropiadamente.

HTTP StatusSignificado
200-299

Éxito

400-499

Hay un problema con la información proporcionada en la solicitud (p. ej. un parámetro faltante). Revise el mensaje de error para determinar cómo arreglarlo.

500-599

Hubo un error interno de Pixian.AI. Espere un momento y vuelva a intentar, y si el problema persiste, envíenos un mensaje de correo electrónico.

Ejemplo de una respuesta de error

{
  "error" : {
    "status" : 400,
    "code" : 1006,
    "message" : "Failed to read the supplied image. "
  }
}

Formato Delta PNG Ancho de banda y latencia más bajos

En Pixian.AI estamos orgullosos de ser el primer servicio de eliminación de fondos en ofrecer resultados en el formato Delta PNG. Los archivos en formato Delta PNG se codifican mucho más rápido y son mucho más pequeños que los PNG regulares. Es por eso que son sumamente adecuados para aplicaciones sensibles a la latencia y al ancho de banda, como las aplicaciones móviles.

Más información Flecha derecha

Eliminar el fondo POST
https://api.pixian.ai/api/v2/remove-background

Para eliminar el fondo de una image, se carga el archivo mediante HTTP POST estándar. Tenga en cuenta que el tipo de contenido tiene que ser multipart/form-data cuando carga archivos binarios.

Parámetros

La imagen original se debe proporcionar como una de:


Binaria

Un archivo binario.


Cadena

Un cadena codificada con base 64. La cadena no puede de más de 1 megabyte.


Cadena

Un URL para obtener y procesar.

Debe ser un archivo .bmp, .gif, .jpeg, .png o .tiff.

El tamaño máximo de una imagen para cargarla (= ancho × altura) es 32.000.000píxeles, que se reduce a max_pixels.


Booleano, predeterminado: false

Pasa en true para indicar que esta es una imagen de prueba.

En el caso de imágenes de producción, omitir o pasar cuando es false.

Las imágenese de prueba se pueden procesar gratis, pero el resultado tendrá una marca de agua incrustada.


Número entero, 100 a 25000000, predeterminado: 25000000

El tamaño máximo de la imagen de entrada (= ancho × altura). Las imágenes más grandes serán reducidas a este tamaño antes de procesarlas.


Formato: '#RRGGBB', p. ej. #0055FF

Color de fondo que se aplicará al resultado. Omitir para dejar un fondo transparente.

Asegúrese de incluir el prefijo '#'.


Booleano, predeterminado: false

Si el resultado se recortará según el objeto en primer plano.

Es muy útil junto con result.margin y result.target_size para siempre obtener un resultado de buen tamaño y centrado.


Formato: '(x.y%|px){1,4}', p. ej. 10px 20% 5px 15%, predeterminado: 0px

Margen que se agregará al resultado.

Se agrega independientemente de que el resultado esté o no recortado según el primer plano.

Si se especifica result.target_size, el margen está en bajorrelieve; es decir, no expande el tamaño resultante efectivo.

Las unidades admitidas son % y px. Sigue la semántica de CSS, por lo que puede usar cualquiera de los siguientes:

  • [all]
  • [top/bottom] [left/right]
  • [top] [left/right] [bottom]
  • [top] [right] [bottom] [left]


Formato: 'w h', p. ej. 1920 1080

Usar un tamaño específico en píxeles. El resultado se ajustará a escalara según el tamaño especificado. Si hay lugar en exceso, siempre se centra horizontalmente, y result.vertical_alignment controla el tratamiento vertical.


Enum, predeterminado: middle

Especifica cómo asignar el espacio vertical excesivo cuando se usa result.target_size.


Enum, predeterminado: auto

Formato resultante. auto se interpreta como png para los resultados transparentes y jpeg para los resultados opacos; es decir, cuando se ha especificado un color de fondo (background.color).

delta_png es un formato avanzado, rápido y altamente compacto, especialmente útil para las situaciones de baja latencia y limitaciones de ancho de banda, como en el caso de las aplicaciones móviles. Codifica el fondo como negro transparente 0x00000000 y el primer plano como blanco transparente 0x00FFFFFF. Los píxeles parcialmente transparentes tienen sus valores de color reales. Puede usar esto con la imagen de entrada para reconstruir el resultado completo. Learn more about the Delta PNG format

background.color, result.crop_to_foreground, result.margin, result.target_size y result.vertical_alignment se ignoran cuando se usa delta_png. El resultado debe ser del mismo tamaño que la imagen de entrada, de lo contrario, fallará la descodificación, así es que max_pixels no debe causar la reducción de la imagen de entrada.


Número entero, 1 a 100, predeterminado: 75

La calidad que se usará al codificar los resultados de la codificación del JPEG.

Encabezados del resultado

X-Credits-Charged Los créditos que se le cobraron.
X-Credits-Calculated Los créditos calculados que se le hubieran cobrado si este fuera un pedido de producción. Solo se produce si se solicita una prueba.
X-Input-Orientation La etiqueta de orientación EXIF de la que leímos y fue aplicada a la imagen de entrada. Es un número entero entre 1 y 8, inclusive. Esto es útil si la biblioteca de carga de imágenes no es compatible con la orientación EXIF. Read more about EXIF orientation here
X-Input-Size [width] [height] de la imagen de entrada en píxeles, antes de aplicar restricciones de tamaño.
X-Result-Size [width] [height] de la imagen resultante, en píxeles.
X-Input-Foreground [top] [left] [width] [height] cuadro limitante del primer plan en las coordinadas de la imagen de entrada.
X-Result-Foreground [top] [left] [width] [height] cuadro limitante del primer plano en las coordinadas de la imagen resultante.

Registro de cambios de la API

FechaCambiar
4 mar 2024 Sección agregada sobre tiempos de espera.
16 ene 2024 Se documentó el objeto JSON del error.
11 ene 2024 Ahora se produce el encabezado X-Credits-Charged y se agregó el encabezado X-Credits-Calculated para pedidos de prueba.
13 jun 2023 Actualización de la API a la versión 2 y los parámetros de camelCase a snake_case para facilidad de lectura. La versión anterior de la API es obsoleta, pero aún está disponible.
3 may 2023 Ampliamos en gran medida los parámetros de la API.
28 abr 2023 Actualizamos el punto de acceso de la API.
21 mar 2023 Publicación inicial.
Obtener la clave de la API