API reference

API reference · Account

The Telegram bot, and this account's link to it

GET/api/account/telegramSigned in session

Whether the bot is on, the bot's username when the deployment named it (ANTIMATTER_TELEGRAM_BOT_USERNAME), and this account's link: when it was made and which model plain text goes to. Off unless ANTIMATTER_TELEGRAM_BOT_TOKEN and ANTIMATTER_TELEGRAM_WEBHOOK_SECRET are both set, and then the answer is `{ enabled: false }` alone.

Answer 200

The bot and this account's link.

Fields of the 200 answer
FieldTypeWhat it is
enabledrequiredbooleanFalse unless the deployment set up the bot.
botUsernamestring or nullThe bot's username without the @.
linkobject or nullNull until a chat is linked.

Errors

  • 401OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter