All pages

Authentication

Bearer keys, and the one place they must never go.

Authorization: Bearer ta_live_…

Create a key in Settings → API keys. It is shown once, at creation, and stored only as a hash — nothing can retrieve it afterwards, including us.

This is not your widget key

Warning

Your public key (pk_…) identifies which agent answers and is meant to be visible in your page source.

Your API key (ta_live_…) can message any of your customers. It belongs in a server's environment. Putting it in your HTML hands anybody the ability to message your entire contact list.

Choose what each key can do

When you create a key, you pick one of three access levels. The level applies everywhere the key is used — your own code calling the API, and the MCP server. A key's access cannot be changed later — create a new key and revoke the old one.

Access levelWhat the key can do
Full accessEverything, including messaging your customers and placing calls. Keys created before access levels existed have full access.
BuildSee everything, and set up agents, knowledge, actions, contacts, webhooks, sequences and their steps, WhatsApp forms, template and one-time-code drafts, projects, teams, saved replies and notification settings, and connect a Telegram bot. It can also test-chat an agent, resolve, take over and assign conversations, and pause a sequence or pause or cancel a campaign. It cannot send messages or codes, place or end calls, reply to a customer, report events, add anyone to a sequence, start a campaign or sequence, publish a form, rent or release a number, clone a voice, or change the workspace, its members or invitations. Test chats and adding knowledge still count towards your usage.
Read-onlySee everything. Change nothing.

If a key tries something its access level does not allow, the request is refused with 403 and a message saying what kind of key it is:

{ "error": "This API key is a build key: it can set up agents, actions, contacts and webhooks, but not message customers, send codes or place calls. Use a full key for that." }

Tip

Connecting an AI assistant such as Claude Code or Cursor to the Katexs MCP server? The MCP server can do exactly what its key can do, so choose Build to let it set things up without being able to contact a customer, or Read-only if it only needs to report. See Connect your assistant to the MCP server.

Acting for one of your customers

If you build your own product on the API, your key reaches each of your customers: add their id in a header.

X-Workspace: org_1f2e…

The request runs inside that customer, with your key's access level. An id that is not one of your customers is 404, whether or not it exists.

Revoking

Immediate. Revoked keys are kept along with their last-used time, because that is the first thing anybody wants to know after a leak.

Rate limits

Per organization, per minute.

HTTP/1.1 429 Too Many Requests
Retry-After: 60

Honour Retry-After. The limit exists because a loop in an integration can spend a month of WhatsApp budget before anybody looks at a dashboard — and because Meta rate-limits the number afterwards. The damage is money first and reputation second.

Note

Idempotency protects you from repeating one request. It does nothing about a thousand different ones. These are separate problems and both are guarded.

Storing the key

API_KEY=ta_live_xxxxxxxxxxxx
const res = await fetch("https://app.katexs.com/api/v1/messages", {
method: "POST",
headers: {
  Authorization: `Bearer ${process.env.API_KEY}`,
  "Content-Type": "application/json",
},
body: JSON.stringify(payload),
});
import os, requests

res = requests.post(
  "https://app.katexs.com/api/v1/messages",
  headers={"Authorization": f"Bearer {os.environ['API_KEY']}"},
  json=payload,
)