Sobre esta API
Encontra o maior rosto da imagem e devolve só o recorte, em JPEG — para avatar, miniatura na ficha do cliente ou para arquivar só o rosto do documento.
Envie a imagem em file — foto, HEIC ou PDF; do PDF, vale a primeira página. A resposta é a imagem, não JSON: o log_id vem no header X-Api4devs-Log-Id.
Motor próprio · Atualização: tempo real
Requisição
POST /api/v1/oracle/face/cropAutenticação HTTP Basic: public_key:secret_key em Base64. Guarde a chave secreta no servidor.
| Cabeçalho | Descrição |
|---|---|
AuthorizationObrigatório | Chave de API em Basic: public_key:secret_key em Base64. |
X-Project-IdOpcional | Projeto que recebe a chamada. Sem ele, vale o projeto padrão da conta. |
Idempotency-KeyOpcional | Repetir a mesma chave em até 24 horas devolve a resposta anterior, sem executar nem cobrar de novo. |
Parâmetros
| Campo | Tipo e local | Descrição |
|---|---|---|
fileObrigatório | filefile | Imagem, HEIC ou PDF contendo um rosto. |
curl --request POST 'https://api.apifordevs.com/api/v1/oracle/face/crop' \
--user "afd_live_pk_...:$AFD_SECRET_KEY" \
--header "X-Project-Id: $AFD_PROJECT_ID" \
--form 'file=@./file.jpg'
import os
import requests
file = open("./file.jpg", "rb")
response = requests.request(
"POST",
"https://api.apifordevs.com/api/v1/oracle/face/crop",
auth=("afd_live_pk_...", os.environ["AFD_SECRET_KEY"]),
headers={"X-Project-Id": os.environ["AFD_PROJECT_ID"]},
files={"file": file},
timeout=30,
)
response.raise_for_status()
print(response.json())
file.close()
import { readFile } from "node:fs/promises";
const form = new FormData();
form.append("file", new Blob([await readFile("./file.jpg")]), "file.jpg");
const response = await fetch("https://api.apifordevs.com/api/v1/oracle/face/crop", {
method: "POST",
headers: {
Authorization: "Basic " + Buffer.from(
"afd_live_pk_...:" + process.env.AFD_SECRET_KEY
).toString("base64"),
"X-Project-Id": process.env.AFD_PROJECT_ID,
},
body: form,
signal: AbortSignal.timeout(30000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());
Campos de resposta
Campos e tipos publicados no catálogo desta API.
Exemplo de resposta
{}
Respostas e cobrança
| HTTP | Descrição | Cobrança |
|---|---|---|
200 | Sucesso. | Sujeita à cobrança |
400
| Arquivo ou parâmetro que a rota não consegue processar, projeto inválido, ou dev_mode=true com chave de produção. | Sem cobrança |
401
| Credencial ausente, inválida ou revogada. | Sem cobrança |
402
| Saldo insuficiente ou limite de gasto diário atingido. | Sem cobrança |
403
| E-mail da conta não verificado, chave sem escopo para o serviço, IP fora da allowlist do projeto ou chave de teste sem dev_mode=true. | Sem cobrança |
409
| Requisição com a mesma Idempotency-Key ainda em andamento. | Sem cobrança |
413
| Arquivo acima de 20 MB. | Sem cobrança |
422
| Parâmetro obrigatório ausente ou fora do formato, ou Idempotency-Key repetida com outro conteúdo. | Sem cobrança |
429
| Limite de requisições por minuto da chave atingido. | Sem cobrança |
500
| Falha interna. | Sem cobrança |
503
| Serviço desativado ou temporariamente indisponível. | Sem cobrança |
Casos de uso
Foto de perfil padronizada
Gerar avatar recortado a partir da foto que o usuário enviou.
Menos imagem pessoal guardada
Recortar o rosto do documento antes de arquivar, reduzindo o que se guarda de imagem pessoal.
Notas de integração
- A resposta é
image/jpeg, sem envelope JSON.X-Api4devs-Log-Ide os headers de cota voltam mesmo assim.