Console overview

Use Agora Console to manage your projects and account settings. Console settings are organized into two groups:

• Project-level settings: Apply to a specific project.
• Account settings: Apply across your entire Agora account.

Project-level view

When you log in to Agora Console, you land on the Home page for the selected project. Use the Project dropdown at the top of the page to switch between projects. Agora creates a default project for you when you create a new account.

Use the sidebar to switch between project-level pages.

Home

The Home page is the landing page for a project in Agora Console. It shows quick links to start building an AI agent, RTC services, your project's App ID and certificate, and a summary of your usage and billing across RTC, Signaling, and Conversational AI.

Credentials

Select Manage credentials on the project card, on the Home page, to open the Project credentials panel. This panel shows the basic identity, security configuration, and credentials for the selected project.

• Project Name: An editable, human-readable name for the project. Select Edit to rename the project.
• Project ID: An internal ID for your project. This is not the App ID.
• Status: The status of your Agora project. Select Disable project to disable it.
• App ID: A unique, non-editable identifier for the project. Select the copy icon to copy the ID to your clipboard.
• Primary certificate: The project's primary server-side secret, used to generate authentication tokens. Enabling the primary certificate (default) secures the project and requires clients to authenticate with a token. Treat the primary certificate like a database password.
• Secondary certificate: An optional fallback certificate used during certificate rotation. Enable it using the Enable Secondary button. You can't delete a secondary certificate while it is enabled; disable it first before deleting.

You can copy your App ID and Primary certificate individually, generate a temporary token, or download your Agora .env file for use in your projects.

Rotate certificates

If you suspect your primary certificate has been compromised, rotate it using the secondary certificate. Replacing the primary certificate may impact your live business, so only rotate certificates when necessary.

1. Select Add a Certificate to enable the secondary certificate.
2. Select Make Primary against the secondary certificate to swap the primary and secondary certificates.
3. Select Disable Secondary to disable the secondary certificate (the original primary certificate).
4. Once your users have switched to the new certificate, select Delete Secondary to delete it.

RTC Services

Select RTC Services in the sidebar to view and configure the Agora products and services available for the current project. Services are grouped into the following categories:

• Intelligence: Conversational AI Engine, Real-Time Speech-to-Text.
• Media: Cloud Recording, Media Push, Video Screenshot Upload, Media Gateway, Media Pull.
• Messaging and Signaling: Signaling, Chat.
• Collaboration: Whiteboard, Flexible Classroom.
• Infrastructure: Cloud Proxy, Co-Host Authentication.

Use the toggle on each product panel to enable or disable it for the project. Select the settings icon to open its configuration panel. For an overview of the available configuration options, refer to the specific product documentation.

Webhooks

A webhook is a callback over HTTPS that allows your app or back-end system to receive notifications. Agora calls your webhook endpoint from its servers to send notifications when selected events occur.

Select Webhooks in the sidebar to view and manage webhooks for the current project.

To configure webhooks:

1. In Agora Console, select Webhooks in the sidebar.

2. Select New Webhook to open the webhook configuration panel.

   

3. From the Product dropdown, select the product for which you want to set up Webhook notifications.

4. Copy the Signing secret. Use this secret to add signature verification.

5. Fill in the following:

   • Region: Select the region where your notifications receiving server is located. Agora connects to the nearest Agora node server based on your selection.

   • Receiving URL: The HTTPS public address of your server that receives the notifications, for example https://1111-123-456-789-99.ap.ngrok.io/ncsNotify. Only HTTPS endpoints are supported.

   • Subscribe to events: Select all the events for which you want to receive notifications.

     If the selected events generate a high number of queries per second (QPS), ensure that your server has sufficient processing capacity.

   • IP whitelist: If your server is behind a firewall, enable this option, then call the IP address query API to get the IP addresses of the Agora Notifications server and add them to the firewall's allowed IP list.

   To reduce the delay in notification delivery, best practice is to activate HTTP persistent connection (also called HTTP keep-alive) on your server with the following settings:

   • MaxKeepAliveRequests: 100 or more
   • KeepAliveTimeout: 10 seconds or more

6. Select Run health check. Agora performs a health test for your configuration as follows:

   1. The health test generates test events that correspond to your subscribed events, and sends callbacks to your server.

      In test event callbacks, the channelName is test_webhook, and the uid is 12121212.

   2. After receiving each test callback, your server must respond within 10 seconds with a status code of 200. The response body must be in JSON format.

7. When the health check succeeds, select Save.

   If the health check fails, follow the prompt in Agora Console to troubleshoot the error. Common errors include the following:

   Status code	Error	Description
   590	Request timeout	Your server does not return the status code 200 within 10 seconds. Check whether your server responds to the request properly. If your server responds to the request properly, contact Agora Technical Support to check if the network connection between the Agora Notifications server and your server is working.
   591	Domain name unreachable	The domain name is invalid and cannot be resolved to the target IP address. Check whether your server is properly deployed.
   592	Certificate error	The Agora Notifications server fails to verify the SSL certificates returned by your server. Check if the SSL certificates of your server are valid. If your server is behind a firewall, check whether you have added all IP addresses of the Agora Notifications server to the firewall's allowed IP list.
   Other	Other response errors	Your server returns a response with a status code other than 200. See the prompt in Agora Console for the specific status code and error messages.

Agora analytics

Select Agora Analytics in the sidebar to open analytics in a new tab. Use it to track and analyze usage and quality data for RTC and Chat. For details, see Agora Analytics overview.

Account settings

Account settings apply across your entire Agora account, not to a single project. Usage, Projects, and Billing are available directly in the sidebar. Access other options by clicking the username at the bottom of the sidebar.

The popup menu shows your current workspace and gives access to Profile, Subscriptions, Extensions, RESTful API Keys, and Settings. It also gives you access to developer and support resources, including documentation, support tickets, and community links (Get Support), as well as account-wide actions like switching the theme (Theme), reverting to the legacy Console (Back to classic console), and signing out (Sign out).

Profile

Use the profile page to update your personal and security details such as your name, email, and phone number. You can also reset your password or connect a Google or GitHub account to enable alternate sign-in methods.

Usage

Select Usage in the sidebar. The Usage page shows your account's usage for the current billing cycle.

• Total Usage: A summary of RTC minutes, agent minutes, and Signaling messages used in the current billing cycle.
• Detailed Usage: A breakdown of usage by product, filterable by project and date range. Select View Breakdown to chart usage over time, and export the data using the download icon.

For deeper usage insights, use Agora Analytics.

Projects

Select Projects in the sidebar to view and manage all projects in your account.

• Search projects by name or App ID.
• Select Create project to create a new project.
• Click the Actions menu next to a project to open its Credentials panel, or perform other project actions.

Subscriptions

The Subscriptions page shows available monthly subscription plans and top-up packs for Agora products. You can view your current subscription, compare included features between various plans, and upgrade or downgrade your subscription. You can also view your purchase history on this page.

For detailed pricing for a specific product, see the product's pricing page.

Billing

Select Billing in the sidebar. The Billing page shows your available and reserved balance, invoices, transactions, payment methods, and billing information.

• Account Balance: Your available balance, with options to top up your wallet or withdraw funds once a payment method is on file.

• Reserved Balance: Funds reserved against estimated usage. Select View Estimate to see the breakdown.

• Your Invoices: Monthly and pre-paid invoices, filterable by date range.

• Transactions: A log of balance movements, filterable by type, plus a separate tab for withdraw requests.

• Payment Methods: Saved cards and bank transfer details used for billing.

  • Cards: Select Add New Card to save a credit card for billing and invoice settlement. Provide the card number, name on card, expiration date, and CVC. Optionally set the card as the default for future payments.

    

  • Bank Transfer: Switch to the Bank Transfer tab for wire transfer instructions, including the beneficiary's name, account number, bank, SWIFT code, and bank address. Include the provided note (your Company ID) in the transfer's notes field.

    Transfers made without the provided note can't be matched to your account and will be disregarded.

• Billing Information: The name and address associated with your billing card.

• Billing FAQ: Information about billing, such as schedule, account suspension policy, payment orders, and refunds.

Extensions

Use the Extensions page to browse and manage extensions that add features to your app on top of Agora SDKs.

Select an extension from the list, then click View details to open the configuration page.

RESTful API keys

This page lists your RESTful API keys, used to authenticate with Agora's RESTful API.

Each key consists of a Customer ID and Customer Secret. Select Create API Key to generate a new key. You can download the Customer Secret only once, so save it somewhere secure. Add a note to a key to help identify it. Select the trash icon to delete a key. You can have a maximum of 10 keys per account.

Settings

The Settings page lets you manage your account information, team members, SSO integration, and notification settings.

Account

Use the Account tab to see your organization name, obtain your company ID, or change your account email. Toggle Two-factor authentication to enable or disable enhanced authentication for sensitive account actions. You can also use this tab to allow Agora customer support to operate your Console for the next 24 hours.

Teams and members

The Teams and Members tab lets you manage who has access to your account.

• Members: Lists each member, their role, status, and any remarks. Select Invite Member to add a new member.
• Roles: Lists each role, its permissions, and the projects it applies to. Permissions cover Usage, Finance, Teams & Members, Projects, XLA, and Agora Analytics access. Agora provides five built-in roles: Finance, Engineer, CS & Maintenance, Product & Operation, and Admin. Built-in roles are locked and can't be edited.

Select Create Role to define a custom role. When creating a role, set:

• Role name: A name for the role.
• Permissions: Access level (None, View, or Edit, depending on the module) for Usage, Finance, Teams & Members, Projects, and XLA.
• Agora Analytics: Access to Call Inspector, Data Insights, and Live Data.
• Data: The projects the role applies to. Select All Projects, or choose specific projects from the list.

SSO management

The SSO Management tab lets you integrate Agora Console with Okta as your identity provider, so your team can log in using their Okta SSO credentials. This integration manages access using SAML and SCIM, and requires an active Premium or Enterprise Support Plan. Select Request to request the integration.

Notification preferences

Use the Notification Preferences tab to configure whether you want to receive notifications from Agora by email or text messages. You can set fine-grained preferences for each type of alert.

To view your notifications press the bell icon next to your username to open the Notifications page. The page lists notifications related to your Agora account. Filter by category using All, Unread, Account, Billing, Product, or System. Select a notification to read its full content.

Get support

The Get support sub-menu provides useful links to Agora documentation, sales, support tickets, and the community platform.