API keys and talkrc files

An API key is how a user or bot can identify their account to Veloxa Talk.

A talkrc file is a configuration file written in the INI file format, which contains key-value pairs, such as an API key and other configuration values, that are necessary for using the Veloxa Talk API with a specific user or bot account on a Veloxa Talk server, for example:

[api]
key=<bot API key>
email=<bot email address>
site=<Veloxa Talk server's URL>
...

For the official clients, such as the Python bindings, we recommend downloading a talkrc file.

Get an 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. In the Actions column, click the manage bot () icon, and scroll down to API key.

  5. Click the copy () icon to copy the bot's API key to your clipboard.

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

  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. Generating a new API key will immediately log you out of this account on all mobile devices.

  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. In the Actions column, click the manage bot () icon, and scroll down to API key.

  5. Click the generate new API key () icon.

  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

Download a talkrc file

  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. In the Actions column, click the manage bot () icon, and scroll down to Talkrc configuration.

  5. Click the download () icon to download the bot's talkrc file, or the copy () icon to copy the file's content to your clipboard.

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

  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 Download talkrc to download your talkrc file.

  7. (optional) If you'd like your credentials to be used by default when using the Veloxa Talk API on your computer, move the talkrc file to ~/.talkrc in your home directory.

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