Esquema Comum
Todos os endpoints da API Annie Insights compartilham parâmetros de solicitação e padrões de resposta comuns.
Parâmetros de solicitação padrão
Cada endpoint baseado em imagem requer estes três parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
PatientID | corda | ✅ Sim | Identificador exclusivo do paciente do seu sistema |
TimeStamp | corda | ✅ Sim | Carimbo de data e hora da sessão de análise (por exemplo, "2026-05-24") |
ImageName | corda | ✅ Sim | URL completo da imagem dentária a ser analisada |
Exemplo de corpo de solicitação
{
"PatientID": "P-001",
"TimeStamp": "2026-05-24",
"ImageName": "https://your-storage.com/images/patient-photo.jpg"
}
Requisitos de URL de imagem
- Deve ser um URL HTTPS acessível publicamente
- Formatos suportados: JPEG, PNG
- Tamanho máximo do arquivo: 20MB
- Resolução recomendada: 1024×768 ou superior
Campos de resposta padrão
| Campo | Tipo | Descrição |
|---|---|---|
Version | corda | Versão da API usada para processamento |
PatientID | corda | Ecoado da solicitação |
TimeStamp | corda | Ecoado da solicitação |
ImageName | corda | Nome do arquivo da imagem processada |
Results | objeto | Resultados de análise específicos de endpoint |
OutputImageUrl | corda | URL de imagem anotada (protegido por SAS, expiração em 72 horas) |
Parâmetros opcionais
Alguns endpoints aceitam parâmetros opcionais adicionais:
| Parâmetro | Tipo | Disponível em | Descrição |
|---|---|---|---|
StandardName | corda | Segmentação Frontal | Padrão de avaliação (padrão: "ICON") |
PlotLabels | booleano | Segmentação Frontal | Mostrar rótulos de classificação na saída |
DrawContours | booleano | Pontos de extremidade de segmentação | Desenhe contornos de contorno na saída |