{"@context": "https://schema.org", "@type": "WebAPI", "name": "Telegram Bot API API", "description": "Auto-generated OpenAPI schema", "provider": {"@type": "Organization", "name": "telegram.org"}, "documentation": "https://josxa.stoplight.io/api/v1/projects/josxa/bot-api/nodes/openapi.json?branch=main"}
Auto-generated OpenAPI schema
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.telegram.org/bot{token}
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Auto-generated OpenAPI schema
| method | path | what the vendor says it does |
|---|---|---|
POST | /addStickerToSet | Use this method to add a new sticker to a set created by the bot. You **must** use exactly one of the fields * |
POST | /answerCallbackQuery | Use this method to send answers to callback queries sent from [inline keyboards](/bots#inline-keyboards-and-on |
POST | /answerInlineQuery | Use this method to send answers to an inline query. On success, *True* is returned. No more than **50** resu |
POST | /answerPreCheckoutQuery | Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in th |
POST | /answerShippingQuery | If you sent an invoice requesting a shipping address and the parameter *is\_flexible* was specified, the Bot A |
POST | /close | Use this method to close the bot instance before moving it from one local server to another. You need to delet |
POST | /copyMessage | Use this method to copy messages of any kind. The method is analogous to the method [forwardMessages](https:// |
POST | /createNewStickerSet | Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus |
POST | /deleteChatPhoto | Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administ |
POST | /deleteChatStickerSet | Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat |
POST | /deleteMessage | Use this method to delete a message, including service messages, with the following limitations: \- A messag |
POST | /deleteStickerFromSet | Use this method to delete a sticker from a set created by the bot. Returns *True* on success. |
POST | /deleteWebhook | Use this method to remove webhook integration if you decide to switch back to [getUpdates](https://core.telegr |
POST | /editMessageCaption | Use this method to edit captions of messages. On success, if the edited message is not an inline message, the |
POST | /editMessageLiveLocation | Use this method to edit live location messages. A location can be edited until its *live\_period* expires or e |
POST | /editMessageMedia | Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a messag |
POST | /editMessageReplyMarkup | Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline |
POST | /editMessageText | Use this method to edit text and [game](https://core.telegram.org/bots/api/#games) messages. On success, if th |
POST | /exportChatInviteLink | Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot mu |
POST | /forwardMessage | Use this method to forward messages of any kind. On success, the sent [Message](https://core.telegram.org/bots |
POST | /getChat | Use this method to get up to date information about the chat (current name of the user for one-on-one conversa |
POST | /getChatAdministrators | Use this method to get a list of administrators in a chat. On success, returns an Array of [ChatMember](https: |
POST | /getChatMember | Use this method to get information about a member of a chat. Returns a [ChatMember](https://core.telegram.org/ |
POST | /getChatMembersCount | Use this method to get the number of members in a chat. Returns *Int* on success. |
POST | /getFile | Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can downlo |
POST | /getGameHighScores | Use this method to get data for high score tables. Will return the score of the specified user and several of |
POST | /getMe | A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the |
POST | /getMyCommands | Use this method to get the current list of the bot's commands. Requires no parameters. Returns Array of [BotCo |
POST | /getStickerSet | Use this method to get a sticker set. On success, a [StickerSet](https://core.telegram.org/bots/api/#stickerse |
POST | /getUpdates | Use this method to receive incoming updates using long polling ([wiki](https://en.wikipedia.org/wiki/Push_tech |
POST | /getUserProfilePhotos | Use this method to get a list of profile pictures for a user. Returns a [UserProfilePhotos](https://core.teleg |
POST | /getWebhookInfo | Use this method to get current webhook status. Requires no parameters. On success, returns a [WebhookInfo](htt |
POST | /kickChatMember | Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channel |
POST | /leaveChat | Use this method for your bot to leave a group, supergroup or channel. Returns *True* on success. |
POST | /logOut | Use this method to log out from the cloud Bot API server before launching the bot locally. You **must** log ou |
POST | /pinChatMessage | Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, |
POST | /promoteChatMember | Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in |
POST | /restrictChatMember | Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for thi |
POST | /sendAnimation | Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent [M |
POST | /sendAudio | Use this method to send audio files, if you want Telegram clients to display them in the music player. Your au |
and 34 more operation(s) in this specification, all searchable.
specification origin: https://josxa.stoplight.io/api/v1/projects/josxa/bot-api/nodes/openapi.json?branch=main
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.