RichAPI keeps settings on two dashboard pages. The Settings page has two tabs: Profile holds your picture, name, language, email, password, and multi-factor authentication, and Team holds the workspace logo and the workspace name. The API Keys page holds the API keys of the workspace.
Where are the RichAPI settings pages?
Page | URL path | What the page holds |
Settings, Profile tab |
| profile picture, name, language, email, password, multi-factor authentication |
Settings, Team tab |
| Team Logo, Team Name |
API keys |
| key creation, revocation, deletion |
[account] is the workspace URL fragment. For a workspace with the URL fragment acme-corp, the settings page is /home/acme-corp/settings.
The sidebar shows the settings page under Account > Settings. The page opens on the Profile tab. The sidebar shows the key page under API Platform > API Keys.
How to change the RichAPI workspace name
Only the workspace owner can change the workspace name. For every other member, the dashboard disables the field, and the API returns 403.
Select Account > Settings in the sidebar.
Select the Team tab.
Find the Team Name card.
Type the new name in the Team Name field.
Select Update Team.
The dashboard shows the message Team successfully updated.
Rule | Limit |
Minimum length | 2 characters |
Maximum length | 50 characters |
Blocked characters | See the list below the table. |
Reserved names |
|
The name must contain no special character from this set:
! @ # $ % ^ & * ( ) + = [ ] { } ; : " \ | , . < > / ?
Does a rename change the RichAPI workspace URL?
Yes. RichAPI generates the workspace URL fragment from the workspace name, so a rename moves the workspace to a new URL. RichAPI recomputes the fragment on every name change. If another workspace already holds the fragment, RichAPI appends -1, -2, and so on.
CAUTION: Update every saved link and browser bookmark after a rename. The old URL fails, and RichAPI returns you to your first workspace. To reach the renamed workspace, open the account switcher and select it there.
After a successful rename, the dashboard redirects you to the new URL by itself.
You cannot choose the URL fragment. If the new name contains non-Latin characters, the form shows a Team URL field, and the field accepts lowercase letters a-z, numbers 0-9, and hyphens.
For workspace switching, read Creating and Switching Between Workspaces.
How to change the RichAPI workspace logo
Only the workspace owner can change the workspace logo.
Select Account > Settings in the sidebar.
Select the Team tab.
Find the Team Logo card.
Select the upload area.
Choose an image file.
RichAPI deletes the old file and stores the new one. To remove the logo, select Clear next to the image.
What theme options does RichAPI have?
RichAPI has three theme options.
Option | Label in the menu | Behavior |
| Light | The dashboard always uses the light palette. |
| Dark | The dashboard always uses the dark palette. |
| System | The dashboard follows the operating system setting. |
The default theme mode is light.
How to switch the RichAPI theme
Select your profile avatar at the bottom of the sidebar.
Hover over or select the Theme submenu.
Select Light, Dark, or System.
RichAPI stores the choice in a theme cookie for one year. The theme applies to every page of the dashboard, not to one workspace.
Which languages does the RichAPI dashboard support?
The RichAPI dashboard supports 10 languages. An English dashboard shows the labels below.
Language | Locale code |
English (default) |
|
Spanish |
|
French |
|
German |
|
Chinese |
|
Turkish |
|
Italian |
|
Dutch |
|
Bangla |
|
Arabic |
|
How to change the dashboard language
Select Account > Settings in the sidebar. The page opens on the Profile tab.
Find the Language card.
Select a language in the list.
RichAPI stores the choice in a lang cookie and reloads the page. The same list also sits at the bottom of the sidebar.
What does the RichAPI Profile tab hold?
The Profile tab of the Settings page holds your own settings. They apply to your user in every workspace. The tab shows six cards: Your Profile Picture, Your Name, Language, Update your Email, Update your Password, and Multi-Factor Authentication.
For the steps behind each card, read Managing Your Personal Profile and Settings.
Does a RichAPI account use a password?
Yes. You sign in with your email address and a password. To change the password, use the Update your Password card on the Profile tab. If you forgot it, select Forgot Password? on the sign-in page.
To add a second step to your sign-in, enroll an authenticator factor.
How does RichAPI multi-factor authentication work?
RichAPI uses time-based one-time password (TOTP) factors. The Multi-Factor Authentication card on the Profile tab holds the factor list and the Setup a new Factor button. Enroll an authenticator application, then type the 6-digit code that the application generates.
After enrollment, RichAPI sends you to /auth/verify at every sign-in and asks for a fresh code.
For the enrollment steps, the factor table, recovery, and troubleshooting, read Securing Your Account with Multi-Factor Authentication.
Can I see active sessions and devices in RichAPI?
No. The RichAPI dashboard has no session list, no device list, and no "sign out of all devices" control. Sign out in the account menu ends the current browser session only.
How does RichAPI handle API keys?
The API Keys page at /home/[account]/api-keys holds key creation, key revocation, and key deletion. A workspace holds up to 3 active API keys at a time.
CAUTION: Copy the key value before you close the create dialog. RichAPI stores only a SHA-256 digest of the value and the first 8 characters, so nobody can recover the full key.
Key setting | Limit or rule |
Active API keys per workspace | 3 |
Maximum name length | 100 characters |
Key value length | 40 characters |
Prefix that the dashboard shows | first 8 characters, followed by |
Members who can manage keys | every member of the workspace |
For the creation steps, the difference between Revoke and Delete, and troubleshooting, read Creating and Managing API Keys.
How to rotate a RichAPI API key
CAUTION: A workspace can hold up to 3 active keys, so you can rotate with no downtime: create the new key first, move your applications to it, then revoke the old key.
Open
/home/[account]/api-keys.Select Create New Key.
Type a name, then select Create Key.
Copy the new value into your secret manager.
Select the confirmation checkbox, then select Done.
Deploy the new value to every application.
Select Revoke on the old key, then select Revoke Key.
A revocation takes effect at once: RichAPI stops the old key immediately.
How to test a RichAPI API key
Send a request to GET /usage. The endpoint returns your credit totals and costs 0 credits, so the test charges nothing. A 401 response means that the key is wrong or revoked.
cURL
curl -X GET https://api.richapi.ai/api/v1/usage
-H "x-api-key: YOUR_API_KEY"
Python
import requests
response = requests.get(
"https://api.richapi.ai/api/v1/usage",
headers={"x-api-key": "YOUR_API_KEY"},
timeout=60,
)
response.raise_for_status()
print(response.json())
Node.js
const response = await fetch("https://api.richapi.ai/api/v1/usage", {
method: "GET",
headers: {
"x-api-key": "YOUR_API_KEY",
},
});
const data = await response.json();
console.log(data);
Does RichAPI support SSO and SAML?
Yes. RichAPI supports SAML 2.0 single sign-on. The sign-in page shows a Sign in with SSO button and a Work email field. RichAPI reads the domain of the address and sends you to the identity provider of that domain.
RichAPI also serves an identity-provider entry point at /auth/sso/<domain>. An administrator adds that URL as the application tile in the identity provider portal. If RichAPI cannot start SSO for the domain, it returns you to the sign-in page with the message We couldn't start SSO sign-in. Please try again, or contact your administrator if the problem continues.
Where is the workspace Danger Zone?
The Team tab of the Settings page shows two cards: Team Logo and Team Name. It shows no Danger Zone card, so it shows no Leave Team button and no Delete Team button. The dashboard has no self-service control that removes your own membership or closes a workspace.
To hand a workspace over and leave it, promote a new Owner first, then write to [email protected].
Task | How RichAPI does it today |
Leave a workspace | Ask an Owner to remove you on the Members tab of the Organization page. |
Close a workspace | Write to |
Remove a member | An Owner removes the member on the Members tab of the Organization page. |
WARNING: Save the records that you need before you ask for a closure. A closure removes the workspace, the API keys, and the usage history, and nobody can undo it. The credit balance belongs to the organization, not to the workspace.
For the removal procedure, the ownership rules, and the closure request, read Leaving a Workspace and Transferring Ownership.
How to close your personal RichAPI account
WARNING: Save the data that you need before you ask for the closure. Nobody can undo the closure of an account.
The Profile tab shows no Danger Zone card, so account closure has no self-service button. Write to [email protected] from the address on your account and ask for the closure.
To leave one workspace and keep your account, ask an Owner of that workspace to remove you on the Members tab of the Organization page. For the ownership rules, read Leaving a Workspace and Transferring Ownership.
Frequently asked questions
Can I recover a RichAPI API key after I close the dialog?
No. RichAPI stores only a SHA-256 digest of the key and the first 8 characters of the value. Create a new key and revoke the old one.
How many active API keys can one RichAPI workspace hold?
Three. A workspace can hold up to 3 active API keys simultaneously. To replace a key, create the new key first, move your applications to it, then revoke the old key.
Does the RichAPI theme setting apply to my whole account?
Yes. RichAPI stores the theme in a browser cookie for one year. The theme applies to every workspace that you open in that browser.
Who can rename a RichAPI workspace?
Only the workspace owner can rename a workspace or change its logo. For every other member, the dashboard disables the fields, and the API returns 403.
Does a rename break a saved link to a RichAPI workspace?
Yes. RichAPI builds the workspace URL from the workspace name, so a rename moves the workspace to a new URL. Open the account switcher and select the workspace again.
Does a RichAPI API key revocation charge credits?
No. Key creation, key revocation, and key deletion charge no credits. RichAPI charges credits for successful API requests only.
Can I sign out of every device at once in RichAPI?
No. The dashboard has one Sign out control, and it ends the current browser session only. To lock out a compromised integration, revoke its API key.
Related articles