Sobre esta API

Sugere o gênero provável (M ou F) a partir do nome e de uma foto, com o nível de confiança e uma justificativa curta.

Envie o nome em name e a foto em file. confidence vem como Alta, Média ou Baixa.

É uma sugestão para personalizar a comunicação, não uma afirmação sobre a pessoa: não use para decidir preço, crédito ou acesso.

Tecnologia

Visão computacional · Atualização: tempo real

Requisição

POST /api/v1/oracle/people/gender

Autenticação HTTP Basic: public_key:secret_key em Base64. Guarde a chave secreta no servidor.

Cabeçalho	Descrição
`Authorization` Obrigatório	Chave de API em Basic: `public_key:secret_key` em Base64.
`X-Project-Id` Opcional	Projeto que recebe a chamada. Sem ele, vale o projeto padrão da conta.
`Idempotency-Key` Opcional	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
`name` Obrigatório	stringform	Nome da pessoa. Exemplo: `Maria Silva`
`file` Obrigatório	filefile	Foto da pessoa (JPEG, PNG, WEBP ou HEIC).

1curl --request POST 'https://api.apifordevs.com/api/v1/oracle/people/gender' \
2  --user "afd_live_pk_...:$AFD_SECRET_KEY" \
3  --header "X-Project-Id: $AFD_PROJECT_ID" \
4  --form 'file=@./file.jpg' \
5  --form 'name=Maria Silva'

1import os
2import requests
3
4file = open("./file.jpg", "rb")
5response = requests.request(
6    "POST",
7    "https://api.apifordevs.com/api/v1/oracle/people/gender",
8    auth=("afd_live_pk_...", os.environ["AFD_SECRET_KEY"]),
9    headers={"X-Project-Id": os.environ["AFD_PROJECT_ID"]},
10    files={"file": file},
11    data={"name": "Maria Silva"},
12    timeout=30,
13)
14response.raise_for_status()
15print(response.json())
16file.close()

1import { readFile } from "node:fs/promises";
2const form = new FormData();
3form.append("file", new Blob([await readFile("./file.jpg")]), "file.jpg");
4form.append("name", "Maria Silva");
5
6const response = await fetch("https://api.apifordevs.com/api/v1/oracle/people/gender", {
7  method: "POST",
8  headers: {
9    Authorization: "Basic " + Buffer.from(
10      "afd_live_pk_...:" + process.env.AFD_SECRET_KEY
11    ).toString("base64"),
12    "X-Project-Id": process.env.AFD_PROJECT_ID,
13  },
14  body: form,
15  signal: AbortSignal.timeout(30000),
16});
17if (!response.ok) throw new Error(`HTTP ${response.status}`);
18console.log(await response.json());

Campos de resposta

Campos e tipos publicados no catálogo desta API.

Sugestãosuggestionobject: Sugestão probabilística. Não é afirmação e não deve decidir nada sozinha.
Gênero sugeridosuggestion.suggested_genderstring
Confiançasuggestion.confidencestring
Justificativasuggestion.reasoningstring

Exemplo de resposta

1{
2  "success": true,
3  "code": 200,
4  "code_message": "A requisição foi processada com sucesso.",
5  "errors": [],
6  "header": null,
7  "data_count": 1,
8  "data": [
9    {
10      "suggestion": {
11        "suggested_gender": "F",
12        "confidence": "Alta",
13        "reasoning": "O nome é tipicamente feminino e a imagem corrobora essa análise."
14      }
15    }
16  ]
17}

Respostas e cobrança

HTTP	Descrição	Cobrança
`200`	Sucesso.	Sujeita à cobrança
`400` `bad_request` `live_key_cannot_use_dev_mode`	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` `unauthorized`	Credencial ausente, inválida ou revogada.	Sem cobrança
`402` `payment_required`	Saldo insuficiente ou limite de gasto diário atingido.	Sem cobrança
`403` `forbidden` `ip_not_allowed` `test_key_cannot_run_live`	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` `conflict`	Requisição com a mesma `Idempotency-Key` ainda em andamento.	Sem cobrança
`413` `payload_too_large`	Arquivo acima de 20 MB.	Sem cobrança
`422` `validation_error`	Parâmetro obrigatório ausente ou fora do formato, ou `Idempotency-Key` repetida com outro conteúdo.	Sem cobrança
`429` `rate_limit_exceeded`	Limite de requisições por minuto da chave atingido.	Sem cobrança
`500` `internal_error`	Falha interna.	Sem cobrança
`503` `service_unavailable`	Serviço desativado ou temporariamente indisponível.	Sem cobrança

Casos de uso

Comunicação personalizada

Ajustar o tratamento em e-mail e push sem perguntar ao usuário.

Detecção de gênero