Contrato OpenAPI v0.1.0: Alinhado ao arquivo
contracts/openapi.yaml. Endpoints exclusivos do Console (/dashboard/v1) aguardam publicação complementar do backend.
Comparação Facial (1:1)
POST /v1/face/compare
Compara duas imagens faciais e retorna a pontuação de similaridade junto com a classificação conforme o threshold aplicado.
Formas de envio de imagem
- Multipart (
multipart/form-data): Campossource_imageetarget_imagecomo arquivos binários JPEG ou PNG (máximo 5 MB por imagem, lados entre 64 e 6000 px, até 12 MP). - JSON (
application/json): Objetos com campobase64. Não aceita URLs remotas de imagem nemthresholdenviado pelo cliente.
Parâmetros principais
| Campo / Header | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Idempotency-Key | Header (1–128 chars) | Sim | Chave única por operação (retida por 24h; reenvio exige mesmo conteúdo binário). |
| source_image | File / Base64Image | Sim | Imagem de referência (JPEG ou PNG, até 5 MB). |
| target_image | File / Base64Image | Sim | Imagem alvo a ser comparada com a referência (JPEG ou PNG, até 5 MB). |
Interpretando resultados
match/no_match: Resultados decisivos e faturáveis (60000micros = R$ 0,06).inconclusive: Qualidade limítrofe — não é cobrado (credits_consumed_micros: 0).similarity_score: Similaridade cosseno entre-1e1(não é porcentagem de identidade).