Visão geral da API - Macaly Documentation

A API da Macaly permite que aplicações externas criem chats, criem aplicações web com IA e as implementem em produção de forma programática.

Disponível apenas no plano Agências

URL base

https://www.macaly.com

Método	Endpoint	Descrição
POST	`/api/chat`	Criação de um novo chat e início do trabalho
POST	`/api/chat/{chatId}/publish`	Envio de uma mensagem para um chat existente
POST	`/api/client-app/assets/upload`	Envio de um ficheiro e obtenção de uma URL CDN permanente
GET	`/api/chat/{chatId}/status`	Verificação do estado do processamento
GET	`/api/chat/{chatId}/subscribe`	Subscrição do stream em tempo real
POST	`/api/chat/{chatId}/deploy`	Implementação do chat em produção
GET	`/api/chat/{chatId}/deployment`	Verificação do estado da implementação

Os pedidos à API consomem créditos do saldo da tua equipa
A criação de cada chat custa o mesmo que usar a interface web
As tentativas falhadas com a chave API estão sujeitas a um limite de pedidos (5 por minuto por endereço IP)
Consulta o teu uso em Definições → Uso e limites

Todos os erros devolvem um JSON com um campo error:

{
  "error": "Error message here"
}

Estado	Descrição
400	Bad Request: corpo do pedido inválido
401	Unauthorized: chave API inválida ou em falta
402	Payment Required: créditos insuficientes
403	Forbidden: sem permissão ou equipa errada
404	Not Found: recurso não encontrado
422	Unprocessable Entity: erro de validação
429	Too Many Requests: limite de pedidos atingido
500	Internal Server Error: erro do servidor
503	Service Unavailable: o servidor está ocupado, tenta novamente mais tarde