Documentos do desenvolvedor
API neofashion.ai
Gere fotografias de produtos, vídeos e imagens de campanha de maneira programática. A mesma API que a plataforma usa — disponível para sua integração desde o primeiro dia.
URL base
Todos os endpoints são versionados em /api/v1 e servidos por HTTPS. O aplicativo web usa os mesmos endpoints — não há rotas privadas exclusivas da UI.
https://app.neofashion.ai/api/v1 Autenticação
Cada solicitação é autenticada com um token bearer. Há suporte para dois tipos de token, e ambos resolvem para o mesmo contexto de workspace.
Chave de API
Para integrações server-to-server. Crie chaves nas configurações do workspace; cada chave tem escopo para o seu workspace. Disponível nos planos Enterprise.
Authorization: Bearer ne_live_xxxxxxxxxxxx JWT de sessão
Emitido pelo aplicativo web no login. É usado pela própria UI da plataforma e adequado para chamadas de curta duração com escopo de usuário.
Authorization: Bearer eyJhbGci... Todas as solicitações incluem um campo source (ui ou api) e um api_key_id opcional para auditoria e faturamento.
Endpoints
Os endpoints principais de geração e consulta. Trabalhos de longa duração, como vídeo e geração em lote, são executados de forma assíncrona — consulte a geração ou acompanhe as atualizações de status no aplicativo.
| Método | Endpoint | Descrição |
|---|---|---|
| POST | /api/v1/generate/image | Gere uma única foto do produto |
| POST | /api/v1/generate/video | Gere um pequeno vídeo de moda |
| POST | /api/v1/generate/bulk | Trabalho de geração em lote assíncrono |
| POST | /api/v1/sketch-to-photo | Esboço → foto com qualidade de campanha |
| GET | /api/v1/generations | Listar gerações (paginado) |
| GET | /api/v1/generations/:id | Detalhe da geração + status |
| GET | /api/v1/credits/balance | Saldo de crédito atual |
| GET | /api/v1/personas | Personagens do espaço de trabalho |
| GET | /api/v1/models | API de DNA da Marca / Personas |
Formato de resposta
Cada endpoint retorna o mesmo envelope: data, meta (créditos usados, créditos restantes, id da solicitação) e error. Exatamente um entre data e error é definido.
Sucesso
{
"data": {
"id": "gen_01hwz...",
"status": "completed",
"output_url": "https://...",
"credits_used": 50
},
"meta": {
"credits_used": 50,
"credits_remaining": 7950,
"request_id": "req_01hwz..."
},
"error": null
} Erro
{
"data": null,
"meta": { "request_id": "req_01hwz..." },
"error": {
"code": "INSUFFICIENT_CREDITS",
"message": "Credit balance too low for this operation.",
"details": { "required": 50, "available": 20 }
}
} Limites de taxa
Os limites são aplicados por workspace. Quando um limite é excedido, a API retorna 429 RATE_LIMITED com um cabeçalho retry-after.
| Plano | Limite de taxa |
|---|---|
| Enterprise | Personalizado – acordado por contrato, com SLA |
Códigos de erro
Os erros são retornados no campo error, com um code estável, uma mensagem legível e detalhes estruturados.
| Código | HTTP | Significado |
|---|---|---|
INSUFFICIENT_CREDITS | 402 | O saldo do workspace é insuficiente para a operação solicitada. Recarregue ou faça upgrade para continuar. |
UNAUTHORIZED | 401 | O token está ausente, expirou ou é inválido. |
FORBIDDEN | 403 | O token é válido, mas o plano ou a função não permite esta operação. |
NOT_FOUND | 404 | O recurso não existe ou pertence a outro workspace. |
RATE_LIMITED | 429 | Solicitações em excesso — tente novamente após o intervalo indicado. |
PROVIDER_ERROR | 502 | Um provedor de IA upstream falhou. Os créditos são reembolsados e a solicitação pode ser repetida. |
Acesso à API
Pronto para integrar?
O acesso à API está disponível nos planos Enterprise, com onboarding guiado e SLA. Agende uma demo e vamos orientar sua integração.