REST API · v1

Documentação da API

Envie retratos por meio de uma API assíncrona, compartilhe sua carteira de créditos atual e acompanhe cada tarefa e cobrança.

Central do desenvolvedor

Conecte seu app com a ajuda de uma IA

Copie este prompt para o ChatGPT, Claude, Cursor ou seu assistente de programação. Ele perguntará sobre sua stack e, depois, orientará você na configuração das credenciais, na verificação do saldo, no envio da tarefa e na conferência do resultado.

Abrir texto simples

Você não precisa enviar sua chave de API à IA. O prompt orienta você a configurá-la no ambiente do seu próprio servidor.

Ler o prompt completo / copiar manualmente

# FAHR FACE API v1

Você é meu assistente de integração de API. No meu idioma, ajude-me a integrar esta API assíncrona de estimativa de idade a partir de retratos ao meu projeto. Siga o contrato abaixo. Se a documentação atualizada for diferente, explique a diferença antes de alterar a implementação. Não invente endpoints, SDKs nem campos de resposta.

Comece perguntando qual é meu idioma, framework e versão do runtime; se o projeto é novo ou já existe; qual é a hospedagem e se há um servidor disponível; e se preciso de um script CLI, integração com backend ou funcionalidade para a web. Se puder inspecionar meu projeto, confira primeiro sua estrutura, dependências e convenções. Oriente-me em uma etapa pequena e verificável por vez, com comandos para meu sistema operacional, locais dos arquivos, resultados esperados e solução de problemas. Aguarde meu retorno antes de continuar. Siga esta sequência: configurar as credenciais → verificar o saldo gratuitamente → implementar o envio → persistir e consultar uma tarefa → conferir o resultado e a cobrança. Nunca afirme que etapas não executadas foram concluídas com sucesso.

URL base: https://fahrface.org. Documentação: https://fahrface.org/developers; criar chaves: https://fahrface.org/settings/apikeys; adicionar créditos: https://fahrface.org/pricing. Peça-me para criar uma chave com prazo de validade e um limite pequeno. Escopos necessários: face-age:write, face-age:read, credits:read; usage:read somente para o histórico de uso. O segredo é exibido uma única vez. Nunca me peça para colar o segredo real em um chat com IA. Use uma variável de ambiente FAHRFACE_API_KEY disponível apenas no servidor e exclua arquivos locais com segredos do controle de versão. Não coloque segredos no código-fonte, em logs, no navegador ou no código de aplicativos móveis, nem use os prefixos VITE_ ou NEXT_PUBLIC_. Um frontend web deve chamar o proxy do meu próprio backend; esta API não oferece integração CORS com navegadores.

Todos os endpoints usam https://fahrface.org, com Authorization: Bearer <FAHRFACE_API_KEY>. As respostas JSON contêm code, message, data; o sucesso exige code=0. POST usa multipart/form-data com exatamente dois campos: image (um arquivo JPEG, PNG ou WebP, com no máximo 5 MiB e formato real correspondente ao MIME) e consent=appearance-age-2026-10-21. Não são aceitos URLs de imagens remotas, imagens em JSON, lotes ou campos adicionais. Ao usar FormData, deixe o cliente HTTP definir Content-Type, incluindo o boundary. Antes do envio, a própria pessoa usuária precisa confirmar explicitamente que tem 18 anos ou mais, que a foto é dela e que consente com o processamento. Não selecione nem invente o consentimento. Endpoints, escopos e exemplo de resposta:

POST /api/v1/face-age/jobs — face-age:write
GET /api/v1/face-age/jobs/JOB_ID — face-age:read
GET /api/v1/credits — credits:read
GET /api/v1/usage?page=1&pageSize=20 — usage:read

POST 202 / replay 200:
{
  "code": 0,
  "message": "ok",
  "data": {
    "id": "JOB_ID",
    "status": "queued",
    "age": null,
    "creditsCost": 1,
    "billingStatus": "reserved"
  }
}

GET /api/v1/credits → data: available, reserved, testCost, priceVersion
GET /api/v1/usage → data: items, total, page, pageSize

Idempotência: a criação exige Idempotency-Key, com 16 a 128 caracteres ASCII: letras, números, sublinhados ou hífens (um UUID funciona). Gere a chave uma vez para cada novo teste intencional. Antes de enviar, salve a associação dela com os bytes exatos do arquivo original, o MIME e o consentimento. A mesma conta, chave e entrada retornam o job original sem uma nova cobrança; uma entrada diferente com essa chave retorna HTTP 409. Em caso de timeout de rede, tentativas repetidas ou reinicialização do processo, reutilize a chave e o arquivo originais. Nunca gere um UUID dentro de um loop de novas tentativas. Reenviar um job com falha usando a mesma chave ainda retorna esse job; somente um novo teste solicitado explicitamente recebe uma nova chave.

Fluxo assíncrono: um job novo retorna HTTP 202; uma repetição retorna HTTP 200. Salve data.id. Consulte GET /api/v1/face-age/jobs/JOB_ID a cada 10–15 segundos, respeitando Retry-After e o limite de requisições da chave. queued, processing e retrying indicam que o processamento não terminou; succeeded e failed são estados finais. Em caso de sucesso, leia data.age (anos) e data.billingStatus; em caso de falha, leia data.error. A inicialização a frio do HF pode levar alguns minutos. O prazo é de 20 minutos; uma concessão ativa do worker pode atrasar a finalização por mais 4 minutos, seguida da recuperação programada. Um timeout de espera no cliente não significa que o job falhou no servidor. Mantenha o ID do job e permita retomar as consultas; não crie outro teste pago.

Cobrança: cada teste pela API reserva 1 créditos, mantém a cobrança em caso de sucesso e reembolsa uma vez em caso de falha final. Os testes pelo site custam 10 créditos, descontados da mesma carteira. As consultas GET são gratuitas, mas contam para os limites de requisições. Primeiro, consulte GET /api/v1/credits data.available: esse valor já exclui as reservas, então não desconte data.reserved novamente. Requisições rejeitadas antes da criação por saldo insuficiente, imagens inválidas ou limites não são cobradas. Limite da conta: 60 requisições autenticadas por minuto, incluindo consultas; limites individuais de chaves podem ser menores. São permitidos no máximo dois jobs da API simultâneos por conta; uma chave pode permitir apenas um. Os limites de uso das chaves consideram cobranças reservadas e bem-sucedidas; os reembolsos liberam limite. Chaves revogadas ou expiradas não podem fazer consultas. O uso aceita page/pageSize; pageSize pode ser, no máximo, 100.

Erros: verifique o status HTTP e a mensagem, não apenas se a requisição foi concluída. 400: requisição, consentimento ou chave de idempotência inválidos; 401: chave inválida, expirada ou revogada; 403: escopo ausente; 402: créditos insuficientes; 404: job inexistente ou de outra conta; 409: entrada conflitante; 413: arquivo grande demais; 415: formato incorreto; 429: limite de requisições, concorrência ou orçamento da chave atingido; 503: serviço indisponível. Corrija a configuração ou a entrada para erros 400/401/402/403/413/415, em vez de repetir a requisição sem critério. Para 409, restaure a entrada original; use uma chave nova somente para um novo teste intencional. Para 429, verifique a mensagem: limites de requisições/concorrência exigem aguardar conforme Retry-After; para atingir o limite de orçamento, é preciso ajustá-lo. Repita após erros de rede ou 503 com intervalos progressivos limitados, preservando a chave de idempotência do POST. Mantenha o ID do job original após erros de consulta.

Aceitação: primeiro, consulte o saldo gratuitamente. Antes de um envio real, confirme comigo que tenho um retrato próprio elegível, que consinto com o processamento e explique a reserva de créditos. Verifique se a criação retorna um ID de job, se uma repetição com a mesma entrada e chave retorna esse ID, se a consulta chega a um estado final, se o sucesso inclui uma estimativa de idade e exatamente uma cobrança, e se é possível retomar a consulta após atualizar ou reiniciar. Se não houver saldo ou autorização para uma chamada real, informe com honestidade que a verificação foi local/simulada; não afirme que a integração real foi aprovada. Finalize com instruções para executar, nomes das variáveis de ambiente, arquivos alterados e dicas para solucionar problemas. Nunca revele segredos reais nem o conteúdo de fotos.

Privacidade e limites: as fotos são armazenadas temporariamente em ambiente privado e excluídas após o processamento final, com um prazo alternativo de 24 horas para exclusão; o HF processa o retrato. Meu app deve evitar registrar imagens ou chaves nos logs e limpar arquivos temporários. Os resultados estimam a idade aparente em uma foto; não são aconselhamento médico, verificação de identidade nem comprovante de idade. A v1 não oferece callbacks de webhook, URLs de imagens remotas ou endpoint para lotes; não invente esses recursos. Comece perguntando sobre minha stack e implantação e, em seguida, oriente a primeira etapa.

Cobrança

API: 1 crédito por teste concluído com sucesso. Site: 10 créditos por teste. Ambos usam a mesma carteira. A criação pela API reserva 1 crédito; uma falha final devolve esse crédito uma vez.

Envie Authorization: Bearer com o escopo necessário. Use a mesma Idempotency-Key ao repetir solicitações com os mesmos bytes de imagem. Se reutilizar essa chave com dados diferentes, a resposta será HTTP 409. Consultas não consomem créditos.

Endpoints

HTTP	Permissões
POST /api/v1/face-age/jobs	face-age:write
GET /api/v1/face-age/jobs/{id}	face-age:read
GET /api/v1/credits	credits:read
GET /api/v1/usage?page=1&pageSize=20	usage:read

Criar uma tarefa

Use multipart/form-data com um único arquivo de imagem (JPEG, PNG ou WebP, até 5 MB) e o campo de consentimento abaixo. Este endpoint só pode ser usado por adultos que enviem a própria foto com consentimento. URLs remotas e parâmetros extras são rejeitados. Gere uma nova chave de idempotência somente para um novo teste lógico.

# Gere e salve uma chave para cada novo teste; em novas tentativas, execute apenas o curl abaixo usando a chave e a imagem originais.
IDEMPOTENCY_KEY="$(uuidgen)"

curl -X POST 'https://fahrface.org/api/v1/face-age/jobs' \
  -H "Authorization: Bearer $FAHRFACE_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -F 'image=@portrait.jpg' \
  -F 'consent=appearance-age-2026-10-21'

{
  "code": 0,
  "message": "ok",
  "data": {
    "id": "JOB_ID",
    "status": "queued",
    "age": null,
    "creditsCost": 1,
    "billingStatus": "reserved"
  }
}

Consultar resultados

A criação retorna HTTP 202 e um ID de tarefa. Consulte a cada 10–15 segundos. queued, processing e retrying são estados não terminais; succeeded e failed são terminais. A reativação do HF pode levar vários minutos. As tarefas têm prazo de 20 minutos; uma concessão ativa do worker pode atrasar a recuperação final em até quatro minutos adicionais.

curl 'https://fahrface.org/api/v1/face-age/jobs/JOB_ID' \
  -H "Authorization: Bearer $FAHRFACE_API_KEY"

Erros e limites

As respostas usam code/message/data. HTTP 400: solicitação ou consentimento inválido; 401: chave inválida/expirada; 403: escopo ausente; 402: créditos insuficientes; 404: tarefa inexistente ou não pertencente à sua conta; 409: dados alterados; 413/415: tamanho/tipo de imagem inválido; 429: limite de solicitações, simultaneidade ou orçamento; 503: serviço indisponível. Siga Retry-After, reutilize a mesma chave de idempotência e confira message antes de tentar novamente.

As chaves expiram em até um ano. Os limites incluem créditos reservados e usados com sucesso; reembolsos restauram o limite. A conta permite 60 solicitações por minuto e, no máximo, duas tarefas de API ativas.

Os retratos são armazenados temporariamente em um bucket privado e excluídos após o processamento terminal, com um prazo de segurança de 24 horas. O HF processa a foto; as estimativas não são aconselhamento médico, verificação de identidade nem comprovante de idade.