Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions api-reference/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,7 @@ To run this quickstart, you will need:

2. Click **Generate New Key**.
3. Enter some meaningful display name for the key, and then click **Continue**.
4. Next to the new key's name, click the **Copy** icon. The key's value is copied to your system's clipboard.
If you lose this key, simply return to the list and click **Copy** again.
4. The generated key is displayed. Copy this key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this key, you must generate a new one.

- Python 3.9 or higher installed on your local machine.
- A Python virtual environment is recommended for isolating and versioning Python project code dependencies on your local machine,
Expand Down
4 changes: 2 additions & 2 deletions api-reference/troubleshooting/api-key-url.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ If you do not have this URL, email Unstructured Support at [support@unstructured
for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace).
</Note>

b. Click **Generate API Key**.<br/>
b. Click **Generate New Key**.<br/>
c. Follow the on-screen instructions to finish generating the key.<br/>
d. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.<br/>
d. The generated key is displayed. Copy this key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this key, you must generate a new one.<br/>

For the API URL, note the value of the Unstructured API URL that you want to call. To access these API URLs:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
For a **Business** account, before you click **API Keys**, make sure you have selected the organizational workspace you want to create an API key
for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace).

2. Click **Generate API Key**.<br/>
2. Click **Generate New Key**.<br/>
3. Follow the on-screen instructions to finish generating the key.<br/>
4. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.<br/>
4. The generated key is displayed. Copy this key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this key, you must generate a new one.<br/>

After you create the destination connector, add it along with a
[source connector](/api-reference/workflow/sources/overview) to a [workflow](/api-reference/workflow/overview#workflows).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
For a **Business** account, before you click **API Keys**, make sure you have selected the organizational workspace you want to create an API key
for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace).

2. Click **Generate API Key**.<br/>
2. Click **Generate New Key**.<br/>
3. Follow the on-screen instructions to finish generating the key.<br/>
4. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.<br/>
4. The generated key is displayed. Copy this key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this key, you must generate a new one.<br/>

After you create the source connector, add it along with a
[destination connector](/api-reference/workflow/destinations/overview) to a [workflow](/api-reference/workflow/overview#workflows).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@

b. Click **Generate API Key**.<br/>
c. Follow the on-screen instructions to finish generating the key.<br/>
d. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.<br/>
d. The generated key is displayed. Copy this key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this key, you must generate a new one.<br/>
13 changes: 3 additions & 10 deletions ui/account/api-key-url.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,12 @@ or jobs in your Unstructured account, or to manage your Unstructured account.
2. On the sidebar, click **API Keys**.
3. On the **API Keys** tab, click **Generate New Key**.
4. Enter some descriptive name for the API key, and then click **Save**.

The new API key is created and appears in the list of available API keys.

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
name, value, or any other settings.
5. The generated API key is displayed. Copy this API key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this API key, you must generate a new one.

## Get an existing API key's value

1. If you are not already signed in, sign in to your Unstructured account.
2. On the sidebar, click **API Keys**.
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.

If you lose this API key's value, simply repeat this procedure.
After you create an API key and then close its creation confirmation dialog, you can no longer get that API key's value.
You must [create a new API key](#create-a-new-api-key) instead.

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.

Expand Down
3 changes: 1 addition & 2 deletions ui/account/workspaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -217,8 +217,7 @@ An API key can be used only with the workspace for which it was created.
6. In the top navigation bar, click **API Keys**.
7. Click **Generate New Key**.
8. Enter some name for the key, and click **Continue**.
9. To get the key's value, in the list of available keys, click the **Copy** icon next to the newly created key. The key's value is
copies to your system's clipboard.
9. The generated API key is displayed. Copy this API key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this API key, you must generate a new one.

## Delete an API key for a workspace

Expand Down
4 changes: 2 additions & 2 deletions welcome.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@ transformation results for files that are stored locally.
for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace).
</Note>

b. Click **Generate API Key**.<br/>
b. Click **Generate New Key**.<br/>
c. Follow the on-screen instructions to finish generating the key.<br/>
d. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.<br/>
d. The generated key is displayed. Copy this key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this key, you must generate a new one.<br/>

3. Now that you have your Unstructured API key, choose one of the following options to continue:

Expand Down