Documentação da
Integre busca visual por similaridade em sua aplicação. Envie uma imagem e receba produtos similares em milissegundos.
Início Rápido
Autenticação
Todas as requisições requerem autenticação via API Key no header x-api-key
x-api-key: YOUR_API_KEYSubstitua YOUR_API_KEY pela sua chave de API. Você pode obter sua API Key no dashboard após fazer login.
Endpoints
POST
/api/v1/searchBusca Imagem→Imagem
Endpoint principal para busca visual por similaridade. Envia uma imagem e recebe produtos visualmente similares do catálogo indexado.
Nome
Tipo
Descrição
Obrigatório
fileFile (multipart/form-data)
Imagem de consulta (JPG, PNG, WEBP)
Sim
model_typedefault: faststring
Tipo de modelo: 'fast' (rápido) ou 'precision' (preciso). Internamente mapeado para resnet/dino.
Não
kdefault: 12integer
Número de resultados desejados (top-K). Recomendado: múltiplos de 6 ou 12 para layouts grid
Não
categorystring
Filtrar resultados por categoria específica
Não
min_scorefloat
Score mínimo de similaridade (0.0 a 1.0). Resultados abaixo deste valor serão filtrados
Não
session_idstring
ID da sessão para rastreamento de analytics (opcional)
Não
track_impressionsdefault: trueboolean
Se deve rastrear impressions automaticamente para analytics
Não
Informações Adicionais
Tipos de Modelo
- • fast: Rápido, ideal para buscas em tempo real
- • precision: Mais preciso, maior acurácia
Formatos de Imagem
- • JPG, JPEG
- • PNG
- • WEBP
Score de Similaridade
O score varia de 0.0 a 1.0, onde valores mais próximos de 1.0 indicam maior similaridade visual.
Limites
- • Máximo de
k=100resultados por requisição - • Tamanho máximo de imagem: 10MB
- • Rate limit baseado no seu plano