Creating and revoking Textual API keys

To be able to use the Textual SDK, 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 page.

To display the User API Keys page, in the Textual navigation menu, click User API Keys.

Creating a Textual API key

To create a Textual API key:

1. Either:

   • In the API keys panel on the dataset details page, click Create an API Key.

   • On the pipeline details page, click the API key creation icon.

   • On the User API Keys page, click Create API Key.

2. In the Name field, type a name to use to identify the key.

1. Click Create API Key.

2. Textual displays the key value, and prompts you to copy the key. If you do not copy the key and save it to a file, you will not have access to the key. To copy the key, click the copy icon.

Revoking a Textual API key

To revoke a Textual API key, on the User API Keys page, 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.