|
| 1 | +--- |
| 2 | +title: Account API keys and API URLs |
| 3 | +sidebarTitle: API keys and URLs |
| 4 | +--- |
| 5 | + |
| 6 | +import EnterpriseSelfHostedDifferences from '/snippets/general-shared-text/enterprise-self-hosted-differences.mdx'; |
| 7 | + |
| 8 | +<EnterpriseSelfHostedDifferences /> |
| 9 | + |
| 10 | +An API key is a unique string of characters used to authenticate calls to an application programming interface (API). |
| 11 | +In Unstructured, API keys are used as a kind of password that allows code or scripts to call the |
| 12 | +[Unstructured API](/api-reference/overview) to automate an Unstructured account on behalf of an associated account user |
| 13 | +or other entity tied to the API key that is provided with each call. This API key also enables Unstructured to associate |
| 14 | +usage and billing information with the related Unstructured account. |
| 15 | + |
| 16 | +You need an API key whenever you want to call the Unstructured API's |
| 17 | +[Unstructured Workflow Endpoint](/api-reference/workflow/overview) or |
| 18 | +[Unstructured Partition Endpoint](/api-reference/partition/overview). |
| 19 | + |
| 20 | +You do not need an API key to use the [Unstructured user interface](/ui/overview) (UI) to create or manage connectors, workflows, |
| 21 | +or jobs in your Unstructured account, or to manage your Unstructured account. |
| 22 | + |
| 23 | +## View available API keys |
| 24 | + |
| 25 | +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). |
| 26 | +2. On the sidebar, click **API Keys**. |
| 27 | +3. Existing API keys are listed on the **API Keys** tab. |
| 28 | + |
| 29 | +## Create a new API key |
| 30 | + |
| 31 | +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). |
| 32 | +2. On the sidebar, click **API Keys**. |
| 33 | +3. On the **API Keys** tab, click **Generate New Key**. |
| 34 | +4. Enter some descriptive name for the API key, and then click **Save**. |
| 35 | + |
| 36 | +The new API key is created and appears in the list of available API keys. |
| 37 | + |
| 38 | +The only setting you can change for this new API key is its [status](#enable-or-disable-an-existing-api-key). You cannot change its |
| 39 | +name, value, or any other settings. |
| 40 | + |
| 41 | +## Get an existing API key's value |
| 42 | + |
| 43 | +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). |
| 44 | +2. On the sidebar, click **API Keys**. |
| 45 | +3. 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. |
| 46 | + |
| 47 | +If you lose this API key's value, simply repeat this procedure. |
| 48 | + |
| 49 | +If you are concerned that an unauthorized user or other entity might have this API key's value, you should [permanently delete](#permanently-delete-an-existing-api-key) this key. |
| 50 | + |
| 51 | +## Enable or disable an existing API key |
| 52 | + |
| 53 | +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. |
| 54 | +However, you might want the option to re-enable it after you solve your issues or determine that it was not compromised. |
| 55 | + |
| 56 | +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). |
| 57 | +2. On the sidebar, click **API Keys**. |
| 58 | +3. 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. |
| 59 | + |
| 60 | +## Permanently delete an existing API key |
| 61 | + |
| 62 | +<Caution> |
| 63 | + Deleting an existing API key is a permanent operation. Deleted API keys cannot be recovered. |
| 64 | + |
| 65 | + You cannot use a deleted API key to call the Unstructured APIs. |
| 66 | +</Caution> |
| 67 | + |
| 68 | +You might want to permanently delete an existing API key that you know is causing issues or is compromised. |
| 69 | + |
| 70 | +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. |
| 71 | +To rotate an old, existing API key before you permanently delete it: |
| 72 | + |
| 73 | +1. Create a new, replacement API key by following the steps in [Create a new API key](#create-a-new-api-key), earlier on this page. |
| 74 | +2. 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. |
| 75 | +3. Delete the old, existing API key. |
| 76 | + |
| 77 | +To permanently delete an existing API key: |
| 78 | + |
| 79 | +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). |
| 80 | +2. On the sidebar, click **API Keys**. |
| 81 | +3. On the **API Keys** tab, in the list of available keys, click the **Options** vertical ellipsis for the target API key. |
| 82 | +4. Click **Delete**. |
| 83 | +5. Confirm that you want to permanently delete the API key by clicking **Continue**. |
| 84 | + |
| 85 | +## View available API URLs |
| 86 | + |
| 87 | +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 |
| 88 | +Unstructured API's [Unstructured Workflow Endpoint](/api-reference/workflow/overview) or |
| 89 | +[Unstructured Partition Endpoint](/api-reference/partition/overview). |
| 90 | + |
| 91 | +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). |
| 92 | +2. On the sidebar, click **API Keys**. |
| 93 | +3. On the **API Keys** tab, the available API URLs are listed. |
0 commit comments