API keys
Create and revoke the keys that let your own tools read Tera's data.
Where your keys are
A key lets your own tools, or an AI assistant (see Connect your AI assistant), read Tera's data without a person signing in, and what it reads counts toward your company's plan. Every plan includes the API and MCP, and your keys are on the API & MCP page:
- An account for one person: the API & MCP tab of your Account page.
- A team's admin: API & MCP in Organization Administration, with every key of the workspace and who made it (see Who can invite for how to reach it).
- A team's member: the API & MCP tab of your Account page, with your own keys. Your admin can see and revoke them, and they stop if you leave the workspace.
- A company with an API-only account signs in to the API console, which holds the same page.
The key table works the same everywhere. The full list of requests a key can make is in the API reference on our website.
Turn on API access
On Free, Pro and Team, the first time the API & MCP page opens, an admin accepts the API terms for the company: tick I accept the API terms for my company, then choose Get API access. Use Read the API terms first if you want to see them. Once access is on, the page shows Credit balance, Free credits left (renews every month), Rows read this month and Requests for the last 24 hours, with your keys under API keys. Until then, a team's members see that their admin has not turned on API access yet. A licence includes API access, so its page opens on the keys. If the page says API access is not open yet., there is nothing to do there until it opens.
Create a key
- Open the API & MCP page and choose Create key.
- Give it a Key name, for example the system that will use it. The name is for your own records, so you can tell your keys apart.
- Pick when it expires under Expires after: 30 days, 90 days, 1 year (the default) or Never.
- Where your plan includes work emails (Pro, Team, or a licence that includes contact details), tick Can reveal email addresses to let this key look up a person's work email, within your team's reveal allowance.
- Enter your password under Confirm your password. A key works without your password or two-factor code, so we confirm it is you first. If you sign in through your company's identity provider and have no password, leave it empty.
- Choose Create.
The new key appears once, under Your new key. Choose Copy, store it where your tool can read it, then choose Done. We keep only a fingerprint of the key, so it cannot be shown again. If you lose it, revoke it and create another.
Keep a key secret
- Treat a key like a password: anyone who holds it can read Tera's data as your workspace, and nothing else asks for your password or two-factor code.
- Keep it out of shared documents, chat messages, web pages and code that others can read; put it in your tool's secret settings.
- Create one key for each system, named for it, so that you can revoke one without stopping the others.
- Choose the shortest expiry that suits the job.
- If a key may have leaked, revoke it straight away.
See what a key is doing
The table lists each key's Name, the public start of the Key, its Access, when it was Created and Last used (Never if it has not been used) and its Status: Active, Expired or Revoked. Search by name or key above the table.
Above the table, the API & MCP page shows Active keys, Credits used for the billing period, and Requests and Records served over the last 24 hours. For one key, open its Actions menu and choose View usage: a summary of requests, records served and credits, then each call with its Route, Status, Records, Credits and When. A key that has not been used shows This key has not been used yet.
Revoke a key
Open the key's Actions menu, choose Revoke and confirm under Revoke this key? Anything using the key stops working immediately, and this cannot be undone. A revoked key stays in the table with the status Revoked; to carry on, create a new key and give it to your tool.