Get Status
curl --request GET \
--url https://macaly.com/api/chat/{chatId}/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://macaly.com/api/chat/{chatId}/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://macaly.com/api/chat/{chatId}/status', 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/{chatId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/{chatId}/status"
req, _ := http.NewRequest("GET", 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.get("https://macaly.com/api/chat/{chatId}/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://macaly.com/api/chat/{chatId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyEndpoints
Get status
Poll the status of a chat workflow
GET
/
api
/
chat
/
{chatId}
/
status
Get Status
curl --request GET \
--url https://macaly.com/api/chat/{chatId}/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://macaly.com/api/chat/{chatId}/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://macaly.com/api/chat/{chatId}/status', 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/{chatId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/{chatId}/status"
req, _ := http.NewRequest("GET", 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.get("https://macaly.com/api/chat/{chatId}/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://macaly.com/api/chat/{chatId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyPoll the status of a chat workflow. Useful for checking if a chat has finished processing without needing to maintain a streaming connection.
Request
GET /api/chat/{chatId}/status
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer macaly_... |
Path Parameters
| Parameter | Type | Description |
|---|---|---|
chatId | string | The chat ID returned from POST /api/chat |
Example Request
curl https://www.macaly.com/api/chat/abc123/status \
-H "Authorization: Bearer macaly_abc123..."
const response = await fetch(
`https://www.macaly.com/api/chat/${chatId}/status`,
{
headers: {
'Authorization': 'Bearer macaly_abc123...',
},
}
);
const data = await response.json();
console.log(data.status);
import requests
response = requests.get(
f'https://www.macaly.com/api/chat/{chat_id}/status',
headers={
'Authorization': 'Bearer macaly_abc123...',
},
)
data = response.json()
print(data['status'])
Response
{
"chatId": "abc123",
"url": "https://www.macaly.com/chat/abc123",
"status": "completed",
"result": {
"content": "Here's what I built for you..."
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
chatId | string | The chat ID |
url | string | URL to view the chat in browser |
status | string | Current workflow status (see below) |
result.content | string | Final assistant message (only when completed) |
error.message | string | Error description (only when failed) |
Status Values
| Status | Description |
|---|---|
running | Workflow is currently executing |
completed | Finished successfully |
failed | Encountered an error |
cancelled | Workflow was manually cancelled |
no_active_workflow | No workflow found for this chat |
Status Codes
| Status | Description |
|---|---|
| 200 | Success |
| 401 | Invalid or missing API key |
| 403 | Chat does not belong to your team |
| 404 | Chat not found |
Polling Pattern
while true; do
STATUS=$(curl -s https://www.macaly.com/api/chat/$CHAT_ID/status \
-H "Authorization: Bearer macaly_...")
echo "Status: $(echo $STATUS | jq -r .status)"
if echo "$STATUS" | grep -q '"status":"completed"'; then
echo "Done!"
break
fi
sleep 2
done
Next Steps
Once status iscompleted, you can:
- Deploy the app using
POST /api/chat/{chatId}/deploy
⌘I