Visão geral da API - Macaly Documentation

A API do Macaly permite que aplicações externas criem sessões de chat, construam aplicações web com IA e as publiquem em produção de forma programática.

Disponível apenas no plano Agência

URL base

https://www.macaly.com

Primeiros passos

Obtenha uma chave de API: veja Autenticação
Crie um chat: envie um prompt para começar a construir
Aguarde a conclusão: espere a IA terminar
Publique: coloque sua aplicação em produção

Endpoints disponíveis

Método	Endpoint	Descrição
POST	`/api/chat`	Cria um novo chat e começa a construir
POST	`/api/chat/{chatId}/publish`	Envia uma mensagem para um chat existente
POST	`/api/client-app/assets/upload`	Envia um arquivo e retorna uma URL permanente na CDN
GET	`/api/chat/{chatId}/status`	Consulta o status do workflow
GET	`/api/chat/{chatId}/subscribe`	Assina o stream em tempo real
POST	`/api/chat/{chatId}/deploy`	Publica o chat em produção
GET	`/api/chat/{chatId}/deployment`	Consulta o status da publicação

Limites e créditos

As requisições à API consomem créditos do saldo do seu workspace
Cada chat criado custa o mesmo que na interface web
Tentativas com chave de API inválida são limitadas (5 por minuto por IP)
Acompanhe seu uso em Configurações → Uso e limites

Tratamento de erros

Todos os erros retornam JSON com um campo error:

{
  "error": "Error message here"
}

Códigos de status HTTP

Código	Descrição
400	Bad Request: corpo da requisição inválido
401	Unauthorized: chave de API inválida ou ausente
402	Payment Required: créditos insuficientes
403	Forbidden: sem permissão ou workspace incorreto
404	Not Found: recurso não encontrado
422	Unprocessable Entity: erro de validação
429	Too Many Requests: limite de requisições excedido
500	Internal Server Error: erro no servidor
503	Service Unavailable: servidor ocupado, tente novamente mais tarde