API keys

An API key is how a bot identifies itself to Zulip. For the official clients, such as the Python bindings, we recommend downloading a zuliprc file. This file contains an API key and other necessary configuration values for using the Zulip API with a specific account on a Zulip server.

Get a bot's API key

  1. Click on the gear () icon in the upper right corner of the web or desktop app.

  2. Select Personal settings.

  3. On the left, click Bots.

  4. Click Active bots.

  5. Find your bot. The bot's API key is under API KEY.

Anyone with a bot's API key can impersonate the bot, so be careful with it!

Get your API key

  1. Click on the gear () icon in the upper right corner of the web or desktop app.

  2. Select Personal settings.

  3. On the left, click Account & privacy.

  4. Under API key, click Manage your API key.

  5. Enter your password, and click Get API key. If you don't know your password, click reset it and follow the instructions from there.

  6. Copy your API key.

Anyone with your API key can impersonate you, so be doubly careful with it.

Invalidate an API key

To invalidate an existing API key, you have to generate a new key.

Invalidate a bot's API key

  1. Click on the gear () icon in the upper right corner of the web or desktop app.

  2. Select Personal settings.

  3. On the left, click Bots.

  4. Click Active bots.

  5. Find your bot.

  6. Under API KEY, click the refresh () icon to the right of the bot's API key.

Invalidate your API key

  1. Click on the gear () icon in the upper right corner of the web or desktop app.

  2. Select Personal settings.

  3. On the left, click Account & privacy.

  4. Under API key, click Manage your API key.

  5. Enter your password, and click Get API key. If you don't know your password, click reset it and follow the instructions from there.

  6. Click Generate new API key