If you signed up for Unstructured through the For Enterprise page, or if you are using a self-hosted deployment of Unstructured, the following information
might apply differently to you. For details, contact Unstructured Sales at sales@unstructured.io.
View available API keys
- Sign in to your Unstructured account, at https://platform.unstructured.io.
- On the sidebar, click API Keys.
- Existing API keys are listed on the API Keys tab.
Create a new API key
- Sign in to your Unstructured account, at https://platform.unstructured.io.
- On the sidebar, click API Keys.
- On the API Keys tab, click Generate New Key.
- Enter some descriptive name for the API key, and then click Save.
Get an existing API key’s value
- Sign in to your Unstructured account, at https://platform.unstructured.io.
- On the sidebar, click API Keys.
- On the API Keys tab, in the list of available keys, click the Copy icon for the target key. The key’s value is copied to your system’s clipboard.
Enable or disable an existing API key
You might want to temporarily disable an existing API key that you suspect is causing some kind of issue or might be compromised in some way. However, you might want the option to re-enable it after you solve your issues or determine that it was not compromised.- Sign in to your Unstructured account, at https://platform.unstructured.io.
- On the sidebar, click API Keys.
- On the API Keys tab, in the list of available keys, switch the Status toggle on or off for the target API key to enable or disable that key, respectively.
Permanently delete an existing API key
You might want to permanently delete an existing API key that you know is causing issues or is compromised. If you have any code or scripts that rely on the old, existing API key that you want to permanently delete, you should rotate the key first. To rotate an old, existing API key before you permanently delete it:- Create a new, replacement API key by following the steps in Create a new API key, earlier on this page.
- Update your code or scripts that rely on the old, existing API key’s value that you want to permanently delete with the new, replacement API key’s value.
- Delete the old, existing API key.
- Sign in to your Unstructured account, at https://platform.unstructured.io.
- On the sidebar, click API Keys.
- On the API Keys tab, in the list of available keys, click the Options vertical ellipsis for the target API key.
- Click Delete.
- Confirm that you want to permanently delete the API key by clicking Continue.
View available API URLs
In some cases, you might need to specify a particular API URL to call one of the Unstructured API’s available Endpoints. For more information, see the getting started instructions for the Unstructured API’s Unstructured Workflow Endpoint or Unstructured Partition Endpoint.- Sign in to your Unstructured account, at https://platform.unstructured.io.
- On the sidebar, click API Keys.
- On the API Keys tab, the available API URLs are listed.