Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Agora REST (BYOK) — connector documentation

  • MCP endpoint: https://byok-agora-rest.connectorbay.com/mcp
  • REST API: POST https://byok-agora-rest.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-agora-rest.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Agora REST RESTful API customer ID, sent in the X-Upstream-Key header and the RESTful API customer secret in X-Upstream-Key-2 of every request (never stored, logged or cached)
  • Health: https://byok-agora-rest.connectorbay.com/health · Tool schemas: https://byok-agora-rest.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-agora-rest · agent@connectorbay.com

What Agora REST (BYOK) is for

Agora REST (BYOK) lets an AI assistant read your own Agora REST data through the Agora REST API with a key you supply (RESTful API customer ID). Read-only: 7 tools (list_projects, get_project, get_project_usage, list_conversational_agents, list_calls, get_call_statistics, get_usage_by_time). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.agora.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Agora REST. Agora REST and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Agora projects do I have and what are their App IDs?"
  • "Show the details of one Agora project"
  • "How many Agora minutes did my project use last month?"
  • "Which Agora Conversational AI agents are running right now?"
  • "Which Agora calls had quality problems yesterday?"
  • "Which SDK versions had the worst audio freeze rate in this Agora call?"

What it does

  • list_projects: List your Agora projects with project id, name, App ID (vendor_key), enabled status and creation time (app certificates are not returned).
  • get_project: Get one Agora project by id and name: App ID, enabled status and creation time (app certificate is not returned).
  • get_project_usage: Get daily usage of one Agora project for a date range and business type (audio and video, transcoding, recording, cloud recording or miniapp), in seconds by resolution.
  • list_conversational_agents: List Conversational AI agents of a project with id and state (IDLE, STARTING, RUNNING, STOPPING, STOPPED, FAILED), filtered by channel, time range or state.
  • list_calls: List calls of a project in a time range with channel name, start and end time, peak and average callers and audio and video freeze rates (Call Inspector; needs an Agora Analytics plan).
  • get_call_statistics: Get audio or video freeze rate of one call broken down by country, region, network type, SDK version, operating system or device (Call Inspector; needs an Agora Analytics plan).
  • get_usage_by_time: Get a usage metric (users, sessions, channels, peak channels or users, durations) over a time range per hour or day (Data Insights; needs an Agora Analytics plan).

BYOK key

You bring your own Agora REST RESTful API customer ID (https://console.agora.io/restfulApi). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.agora.io over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Notices

Read-only: never creates projects, starts or stops agents, or changes certificates. App certificates are not returned. Call Inspector and Data Insights tools need an Agora Analytics plan.

Data sources

Live from the Agora REST API (api.agora.io) with a BYOK key; documentation: https://docs.agora.io/en/api-reference/api-ref/console/solutions-agora-console-rest-api. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Agora REST. Agora REST and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Agora REST account.

Built for: Worldwide. Languages: English.