Creating and revoking Textual API keys

Required global permission: Create an API key

To be able to use the Tonic Textual Python SDK or the REST API, you must have an API key.

Alternatively, you can use the Textual API to obtain a JSON Web Token (JWT) to use for authentication.

Viewing the list of API keys

You manage keys from the User API Keys section of the User Profile page.

To display the User Profile page:

1. Click the user icon at the bottom of the navigation menu.
2. In the user menu, click User Profile.

User API Keys list on the User Profile page

Creating a Textual API key

To create a Textual API key:

1. From the User API Keys section, click Create New Key.
2. In the API Key Name field, type a name to use to identify the key.

API key creation panel

1. Click the save icon.

Textual adds the key to the list.

Copying a Textual API key

To copy the text of an API key, so that you can use it in an SDK or API request, click its copy icon.

Revoking a Textual API key

To revoke a Textual API key, in the User API Keys list, click the Revoke option for the key to revoke.

Configuring the API key as an environment setting

You cannot instantiate the SDK client without an API key.

Instead of providing the key every time you call the Textual API, you can configure the API key as the value of the environment variable TONIC_TEXTUAL_API_KEY.