Create chat
curl --request POST \
--url https://macaly.com/api/chat \
--header 'Authorization: Bearer <token>'import requests
url = "https://macaly.com/api/chat"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://macaly.com/api/chat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://macaly.com/api/chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://macaly.com/api/chat"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://macaly.com/api/chat")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://macaly.com/api/chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyEndpoints
Create chat
Cria um novo chat e começa a criar com a IA
POST
/
api
/
chat
Create chat
curl --request POST \
--url https://macaly.com/api/chat \
--header 'Authorization: Bearer <token>'import requests
url = "https://macaly.com/api/chat"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://macaly.com/api/chat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://macaly.com/api/chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://macaly.com/api/chat"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://macaly.com/api/chat")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://macaly.com/api/chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyCria um novo chat e inicia o processamento por parte da IA.
Resposta JSON (com
Resposta em stream (com
Quando o streaming está ativo, a resposta é um stream de texto:
A primeira linha contém o ID do chat no formato
Pedido
POST /api/chat
Cabeçalhos
| Cabeçalho | Obrigatório | Descrição |
|---|---|---|
Authorization | Sim | Bearer macaly_... |
Content-Type | Sim | application/json |
Parâmetros do corpo do pedido
| Campo | Tipo | Obrigatório | Predefinição | Descrição |
|---|---|---|---|---|
content | string | Sim | - | A mensagem/prompt do utilizador |
stream | boolean | Não | true | Se false, devolve JSON em vez de um stream |
backend | string | Não | "DEFAULT" | Backend a utilizar |
executionMode | "auto" | "planning" | "build" | Não | - | Determina como a IA aborda a tarefa |
model | "gpt-5.6-terra" | "gpt-6.1-sol" | "gpt-6-luna" | "grok-4-6" | "kimi-k3" | "sonnet-5-5" | "opus-5-5" | "blueai-glm-5-3" | "blueai-glm-5-3-flash" | Não | - | Modelo de IA a utilizar. Se não for especificado, usa o modelo configurado para a equipa |
reasoningEffort | "medium" | "high" | Não | - | Determina quão profundamente o modelo raciocina sobre a tarefa |
experimental_attachments | array | Não | [] | Anexos de ficheiros (formato descrito abaixo) |
Formato dos anexos
Cada elemento do arrayexperimental_attachments tem a seguinte estrutura:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
url | string | Sim | URL do ficheiro a anexar |
name | string | Não | Nome de apresentação do anexo |
contentType | string | Não | Tipo MIME do ficheiro |
Exemplo de pedido
curl -X POST https://www.macaly.com/api/chat \
-H "Authorization: Bearer macaly_abc123..." \
-H "Content-Type: application/json" \
-d '{
"content": "Create a landing page for a coffee shop",
"stream": false
}'
const response = await fetch('https://www.macaly.com/api/chat', {
method: 'POST',
headers: {
'Authorization': 'Bearer macaly_abc123...',
'Content-Type': 'application/json',
},
body: JSON.stringify({
content: 'Create a landing page for a coffee shop',
stream: false,
}),
});
const data = await response.json();
console.log(data.chatId);
import requests
response = requests.post(
'https://www.macaly.com/api/chat',
headers={
'Authorization': 'Bearer macaly_abc123...',
'Content-Type': 'application/json',
},
json={
'content': 'Create a landing page for a coffee shop',
'stream': False,
},
)
data = response.json()
print(data['chatId'])
Resposta
Resposta JSON (com stream: false)
{
"chatId": "abc123def456",
"url": "https://www.macaly.com/chat/abc123def456",
"streamId": "stream_xyz789",
"assistantMessageId": "msg_123"
}
| Campo | Tipo | Descrição |
|---|---|---|
chatId | string | O identificador único do chat |
url | string | URL direta para visualizar o chat |
streamId | string | undefined | Identificador do stream ao qual subscrever. Presente apenas para backends baseados em processamento |
assistantMessageId | string | undefined | ID da mensagem do assistente a ser gerada. Presente apenas para backends baseados em processamento |
Resposta em stream (com stream: true, predefinição)
Quando o streaming está ativo, a resposta é um stream de texto:
2:[{"chatId":"abc123def456"}]
0:"Starting to build..."
...
2:[{"chatId":"..."}].
Extrair o ID do chat do stream
const text = await response.text();
const match = text.match(/2:\[{"chatId":"([^"]+)"/);
const chatId = match?.[1];
Códigos de estado
| Estado | Descrição |
|---|---|
| 200 | Sucesso: chat criado |
| 400 | Corpo do pedido inválido |
| 401 | Chave API inválida ou em falta |
| 402 | Créditos insuficientes |
| 403 | Acesso negado: sem permissão para a equipa especificada |
| 422 | Erro de validação |
| 429 | Limite de pedidos atingido |
| 500 | Erro do servidor |
Próximos passos
Depois de criares um chat:- Acompanha o progresso com
GET /api/chat/{chatId}/status - Subscreve o stream com
GET /api/chat/{chatId}/subscribepara atualizações em tempo real - Envia mensagens seguintes com
POST /api/chat/{chatId}/publish
Esta página foi útil?