canonical: https://jentic.com/apis/sendbird.com/sendbird # SendBird Chat Platform API The SendBird Chat Platform API creates chat users and their session tokens, opens group and open channels, and sends, edits and lists the messages inside them. It also registers bots that post into channels, schedules announcements, appoints channel operators, freezes channels and blocks users, stores channel and user metadata, and reports daily and monthly active user counts. Every call carries an `Api-Token` header and is addressed to the host belonging to one SendBird application. ## For AI agents Create SendBird chat users and channels, send and edit the messages inside them, run bots, moderate members, and schedule announcements. 92 operations, authenticated with an `Api-Token` header. ## Scope Does not handle payments, crm, or developer tools - use for communications only. ## Capabilities - scheduleAnAnnouncement - createABot - listBots - viewBotById - updateBotById - deleteBotById - joinChannels ## Use cases ### Communications Operations Run chat operations from your backend instead of the SendBird dashboard: create users and issue their session tokens, open group and open channels, send and edit the messages inside them, and schedule announcements. Example prompt: Call POST /v3/announcements to schedule an announcement ### Automated Bot Management Chain several SendBird Chat Platform API endpoints in one workflow: create a bot, list the bots registered on the application, add the bot to a set of group channels, and update its nickname or profile later. Example prompt: Call POST /v3/bots to create a bot, then POST /v3/bots/{bot_userid}/channels to add it to group channels ### AI Agent Integration via Jentic AI agents discover and call SendBird Chat Platform API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read the API reference or handle the `Api-Token` header manually. Example prompt: Search Jentic for 'schedule an announcement', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | /v3/announcements | scheduleAnAnnouncement | | POST | /v3/bots | createABot | | GET | /v3/bots | listBots | | GET | /v3/bots/{bot_userid} | viewBotById | | PUT | /v3/bots/{bot_userid} | updateBotById | | DELETE | /v3/bots/{bot_userid} | deleteBotById | | POST | /v3/bots/{bot_userid}/channels | joinChannels | | DELETE | /v3/bots/{bot_userid}/channels | botLeaveGroupChannels | ## Key resources - **Announcement** — Operations related to Announcement - **Bot** — Operations related to Bot - **GroupChannel** — Operations related to GroupChannel - **Message** — Operations related to Message - **Metadata** — Operations related to Metadata ## Why Jentic - **Setup:** Wiring the SendBird Chat Platform API by hand means learning its API-token header auth, resolving the per-application host at `api-{app_id}.sendbird.com`, and managing bots and channels yourself. Through Jentic you install once, import the SendBird Chat Platform API from the API Directory, store the token once, and your agent calls it. - **Permission scoping:** SendBird puts the bot id in the URL path (/v3/bots/{bot_userid}), so a rule can pin your agent to one bot: it can read and update that bot and add it to channels. You choose the operations it may call, so destructive ones like bot deletion are not included unless you add them. - **Credential handling:** Your SendBird Chat Platform API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'schedule an announcement' or 'create a bot', and Jentic returns the matching SendBird Chat Platform API operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Twilio** — Alternative communications API - **Sendgrid** — Alternative communications API - **Pusher** — Complementary communications API ## FAQ ### What authentication does the SendBird Chat Platform API use? The SendBird Chat Platform API uses an API key passed in the `Api-Token` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context. ### Can I schedule an announcement with the SendBird Chat Platform API? Yes. Use the POST /v3/announcements endpoint. The API returns structured JSON responses that agents can parse and act on directly. ### What are the rate limits for the SendBird Chat Platform API? Rate limits are not specified in the OpenAPI spec. Check the SendBird documentation for the limits that apply to your plan. ### How do I schedule an announcement through Jentic? Install self-hosted Jentic One, import the SendBird Chat Platform API from the API Directory, and store your `Api-Token` once. Your agent then searches for 'schedule an announcement', gets back the POST /v3/announcements operation with its input schema, and executes the call with the credential injected at execution time. ### Is there a SendBird Chat Platform API MCP server? You don't need an MCP server to give your agent the SendBird Chat Platform API. Jentic connects it directly from the API Directory: import it, store your credential once, and your agent calls it. ### How many endpoints does the SendBird Chat Platform API have? The SendBird Chat Platform API exposes 92 endpoints across nine resource groups: users, group channels, open channels, messages, bots, announcements, moderation, metadata and statistics. ### Can I limit what my agent is allowed to do with the SendBird Chat Platform API? Yes. Because Jentic One is self-hosted, your own rules decide which SendBird operations and credentials the agent may use. Since the bot id sits in the URL path at /v3/bots/{bot_userid}, you can pin the agent to a single bot so it only views and updates that bot and adds it to channels via POST /v3/bots/{bot_userid}/channels. You choose the operations it may call, so destructive ones like bot deletion (DELETE /v3/bots/{bot_userid}) are excluded unless you explicitly add them. ### Where is the official OpenAPI spec for the SendBird Chat Platform API? SendBird ships one inside its Java platform SDK repository, at `https://raw.githubusercontent.com/sendbird/sendbird-platform-sdk-java/main/api/openapi.yaml`. That document is OpenAPI 3.0.3, titled 'Sendbird Platform SDK' version 1.0.0, and covers 53 paths and 92 operations; SendBird's own Platform API overview page links the repository that holds it. The version in the Jentic API Directory covers the same 92 operations and also declares the `Api-Token` security scheme, which SendBird's document leaves out even though its setup guide states that a master or secondary API token is required on API requests.