Creating and revoking Textual API keys
The Tonic Textual API is a Python SDK that you can use to manage datasets and get access to redacted files.
To be able to use the Textual API, you must have an API key.
If you didn't create an API key when you signed up for Textual, then you can create API keys from the Textual application.
Viewing the list of API keys
You can manage keys from the Textual home page or the User API Keys page.
On the Textual home page, the API Keys panel is at the top right.
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:
Either:
In the API keys panel on the Textual home page, click Create an API Key.
On the User API Keys page, click Create API Key.
In the Name field, type a name to use to identify the key.
Click Create API Key.
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, either:
In the API Keys panel on the Textual home page, click the delete icon for the key to revoke.
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.
Last updated
