VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Biblioteca de mídia

Ferramentas de imagem

Remove o fundo de uma imagem com IA e apara as margens brancas, devolvendo a nova imagem em PNG.

Duas operações de edição que recebem uma imagem e devolvem a imagem editada como image/png (o corpo da resposta é o arquivo, não JSON). Elas não gravam nada na biblioteca: para guardar o resultado, envie-o depois com Enviar arquivo. Exigem o privilégio manage_media.

Entrada comum

As duas rotas aceitam a imagem de duas formas, e o tamanho máximo é de 12 MB:

  • multipart/form-data com o campo file;
  • JSON {"url": "https://..."}, e o servidor baixa a imagem dessa URL.

Remover fundo

POST/api/v1/admin/media/remove-bgAdmin

Remove o fundo de uma imagem com IA

Envia a imagem a um serviço de remoção de fundo (a chave de acesso fica no servidor) e devolve um PNG com fundo transparente. Depende de o serviço estar configurado na plataforma e de haver cota disponível.

Corpo da requisição

filefile
Imagem, em multipart/form-data. Use este campo ou url.
urlstring
URL pública da imagem, em JSON. Use este campo ou file.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/media/remove-bg" \
  -H "Authorization: Bearer $TOKEN" \
  -F "file=@camiseta.jpg" \
  -o camiseta-sem-fundo.png

A resposta 200 tem Content-Type: image/png e o arquivo no corpo.

Aparar bordas

POST/api/v1/admin/media/trim-bordersAdmin

Recorta margens brancas ou transparentes e refaz uma moldura branca leve

Remove as margens brancas ou transparentes da foto e acrescenta uma moldura branca fina e uniforme, o padrão de foto de e-commerce. Devolve PNG. Não usa serviço externo.

Corpo da requisição

filefile
Imagem, em multipart/form-data. Use este campo ou url.
urlstring
URL pública da imagem, em JSON. Use este campo ou file.

A resposta 200 tem Content-Type: image/png e o arquivo no corpo.

Erros

StatusQuandoCorpo
400Nem file nem url; multipart inválido; imagem que não pôde ser processada (aparar bordas){"error":"file or url required"} ou {"error":"trim borders failed","detail":"..."}
401Sem token ou token expirado{"error":"missing authorization header"}
403Sem o privilégio manage_media{"error":"insufficient privileges","required":"manage_media"}
502Não foi possível baixar a url; o serviço de remoção de fundo falhou ou não está configurado{"error":"remove background failed","detail":"..."} ou {"error":"failed to fetch url","detail":"..."}
Falha do download chega como 502

Quando o servidor não consegue baixar a url (endereço errado, bloqueio, tempo esgotado), o erro é 502 e não 400. Prefira enviar o arquivo por multipart quando a imagem não é pública.

Veja também

  • Arquivos
  • Envio temporário
Anterior
Envio temporário
Próxima
Menus de navegação
Nesta página
  • Entrada comum
  • Remover fundo
  • Exemplo de requisição
  • Aparar bordas
  • Erros
  • Veja também