Authentication

Send an API key with every request. A key belongs to your team and gives access to its rooms.

Any change to a room needs a key. So does reading a room that has an output password.

Create a key

Only team admins can create keys, and your team needs a Pro or Premium plan. There are two kinds:

A team key works on every room in the team. Create it on the API Keys page in the header, with New Key.
A room key works on one room. Create it on the API Keys page, or in the room's Controller under Settings ▸ API key.

Give the key a name you'll recognize, up to 50 characters. The key is shown only once, so copy it straight away. It starts with kk_.

The API Keys page, with a list of keys and the New Key button

Send the key

Send it as a bearer token, which is the recommended way:

curl https://app.kloksi.com/api/v1/rooms/ROOM_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

Or as a query parameter, for tools that can't set headers:

curl "https://app.kloksi.com/api/v1/rooms/ROOM_ID?api_key=YOUR_API_KEY"

Anyone with a key can control your rooms, so keep it out of shared documents and public code. Addresses often end up in logs, so use the header when you can.

What a key can do

A key can do what a team member can do in a room's Controller, and it skips any output password.

A key can't:

change another team's rooms, or rooms without a team
change other rooms, if it's a room key
archive, unarchive, delete or duplicate a room
change output passwords or a room's managers
list a team's rooms or add rooms to the team
manage API keys

Manage keys

The API Keys page lists each key's name, scope, a masked version of the key, when it was created, and when it was last used.

Revoke stops a key working immediately, after a confirmation. This can't be undone.

If your team moves to the Free plan, its keys stop working until you upgrade. Their requests get a 403 with plan_required.