Chats

Explain a message

Returns a plain-language reading of one message from the participant, for when the original is unclear. Nothing is sent.

GET

https://api.portal.magicdoor.com/company-app/chats/{chatId}/messages/{messageId}/magic

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

chatIdstringrequired

The chat the message is in.

example: 1830472847398404096

messageIdstringrequired

The message to explain.

example: 1831055120837640192

Response

200 · The explanation.

suggestedTextstring

The explanation. Absent when the AI could not produce one.

failedboolean

true when no explanation could be produced.

401 · The access token is missing, expired, or not valid.

404 · No chat with that id belongs to your company.

Request

curl --request GET \
  --url 'https://api.portal.magicdoor.com/company-app/chats/1830472847398404096/messages/1831055120837640192/magic' \
  --header 'Authorization: Bearer <token>'

Response

{
  "suggestedText": "The tenant is asking whether the water will be shut off during the repair.",
  "failed": false
}