diff --git a/examplecode/tools/mcp.mdx b/examplecode/tools/mcp.mdx
index 4bfec49b..825827d6 100644
--- a/examplecode/tools/mcp.mdx
+++ b/examplecode/tools/mcp.mdx
@@ -45,7 +45,7 @@ Before you begin, you must have an Unstructured account and an Unstructured API
If you choose a pay-per-page plan, after your first 14 days of usage or more than 1000 processed pages per day,
whichever comes first, your account is then billed at Unstructured's standard service usage rates. To keep using the service,
you must
- [provide Unstructured with your payment details](/ui/billing#add-view-or-change-pay-per-page-payment-details).
+ [provide Unstructured with your payment details](/ui/account/billing#add-view-or-change-pay-per-page-payment-details).
To save money by switching from a pay-per-page to a subscribe-and-save plan, go to the
[Unstructured Subscribe & Save](https://unstructured.io/subscribeandsave) page and complete the on-screen instructions.
diff --git a/mint.json b/mint.json
index fec4548b..fd4b7671 100644
--- a/mint.json
+++ b/mint.json
@@ -234,7 +234,15 @@
},
"ui/workflows",
"ui/jobs",
- "ui/billing"
+ {
+ "group": "Account",
+ "pages": [
+ "ui/account/overview",
+ "ui/account/billing",
+ "ui/account/usage",
+ "ui/account/api-key-url"
+ ]
+ }
]
},
{
@@ -645,6 +653,10 @@
{
"source": "/platform-api/partition-api/:slug*",
"destination": "/api-reference/partition/:slug*"
+ },
+ {
+ "source": "/ui/billing",
+ "destination": "/ui/account/billing"
}
],
"analytics": {
diff --git a/snippets/general-shared-text/enterprise-self-hosted-differences.mdx b/snippets/general-shared-text/enterprise-self-hosted-differences.mdx
new file mode 100644
index 00000000..3f5fb204
--- /dev/null
+++ b/snippets/general-shared-text/enterprise-self-hosted-differences.mdx
@@ -0,0 +1,4 @@
+
+ If you signed up for Unstructured through the [For Enterprise](https://unstructured.io/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](mailto:sales@unstructured.io).
+
\ No newline at end of file
diff --git a/ui/account/api-key-url.mdx b/ui/account/api-key-url.mdx
new file mode 100644
index 00000000..536befcf
--- /dev/null
+++ b/ui/account/api-key-url.mdx
@@ -0,0 +1,93 @@
+---
+title: Account API keys and API URLs
+sidebarTitle: API keys and URLs
+---
+
+import EnterpriseSelfHostedDifferences from '/snippets/general-shared-text/enterprise-self-hosted-differences.mdx';
+
+
+
+An API key is a unique string of characters used to authenticate calls to an application programming interface (API).
+In Unstructured, API keys are used as a kind of password that allows code or scripts to call the
+[Unstructured API](/api-reference/overview) to automate an Unstructured account on behalf of an associated account user
+or other entity tied to the API key that is provided with each call. This API key also enables Unstructured to associate
+usage and billing information with the related Unstructured account.
+
+You need an API key whenever you want to call the Unstructured API's
+[Unstructured Workflow Endpoint](/api-reference/workflow/overview) or
+[Unstructured Partition Endpoint](/api-reference/partition/overview).
+
+You do not need an API key to use the [Unstructured user interface](/ui/overview) (UI) to create or manage connectors, workflows,
+or jobs in your Unstructured account, or to manage your Unstructured account.
+
+## View available API keys
+
+1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io).
+2. On the sidebar, click **API Keys**.
+3. Existing API keys are listed on the **API Keys** tab.
+
+## Create a new API key
+
+1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io).
+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.
+
+## Get an existing API key's value
+
+1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io).
+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.
+
+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.
+
+## 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.
+
+1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io).
+2. On the sidebar, click **API Keys**.
+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.
+
+## Permanently delete an existing API key
+
+
+ Deleting an existing API key is a permanent operation. Deleted API keys cannot be recovered.
+
+ You cannot use a deleted API key to call the Unstructured APIs.
+
+
+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:
+
+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.
+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.
+3. Delete the old, existing API key.
+
+To permanently delete an existing API key:
+
+1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io).
+2. On the sidebar, click **API Keys**.
+3. On the **API Keys** tab, in the list of available keys, click the **Options** vertical ellipsis for the target API key.
+4. Click **Delete**.
+5. 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](/api-reference/workflow/overview) or
+[Unstructured Partition Endpoint](/api-reference/partition/overview).
+
+1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io).
+2. On the sidebar, click **API Keys**.
+3. On the **API Keys** tab, the available API URLs are listed.
\ No newline at end of file
diff --git a/ui/billing.mdx b/ui/account/billing.mdx
similarity index 76%
rename from ui/billing.mdx
rename to ui/account/billing.mdx
index d294f796..b5c0cf4b 100644
--- a/ui/billing.mdx
+++ b/ui/account/billing.mdx
@@ -1,16 +1,17 @@
---
-title: Billing
+title: Account billing
+sidebarTitle: Billing
---
To ensure that your Unstructured account has continued access to Unstructured, you must have one of the following plans in place with Unstructured:
- A [pay-per-page plan](https://unstructured.io/developers#get-started) with valid payment details provided.
- A [subscribe-and-save plan](https://unstructured.io/subscribeandsave) plan with a non-zero available budget.
+- An enterprise agreement with Unstructured initiated by signing up through the [For Enterprise](https://unstructured.io/enterprise) page.
-
- You can also enter into an [enterprise agreement](https://unstructured.io/enterprise) with Unstructured.
- For enterprise billing and usage details, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
-
+import EnterpriseSelfHostedDifferences from '/snippets/general-shared-text/enterprise-self-hosted-differences.mdx';
+
+
## Add, view, or change pay-per-page payment details
@@ -18,12 +19,12 @@ After you sign up for a [pay-per-page](https://unstructured.io/developers#get-st
after your first 14 days of usage or more than 1000 processed pages per day, whichever comes first,
you must provide Unstructured with your payment details to continue using the service.
-
-
+
+
1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io).
2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.
3. Click the **Billing** tab.
@@ -35,12 +36,12 @@ Go to the [Unstructured Subscribe & Save](https://unstructured.io/subscribeandsa
## View pay-per-page billing details
-
-
+
+
1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io).
2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.
3. Click the **Billing** tab. A billing overview for the current month and a list of your billing invoices are displayed.
@@ -59,24 +60,12 @@ Go to the [Unstructured Subscribe & Save](https://unstructured.io/subscribeandsa
Email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io) directly with your request.
-## View account usage details
-
-To view usage details for your Unstructured account, do the following:
-
-
-
-
-
-
-
-1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io).
-2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.
-3. Click the **Usage History** tab.
-
-## How are usage and billing calculated?
+## How is billing calculated?
import SharedPagesBilling from '/snippets/general-shared-text/pages-billing.mdx';
-The **Billing** tab shows your account's current billing rate per page.
\ No newline at end of file
+The **Billing** tab shows your account's current billing rate per page.
+
+To complete usage-related tasks in your account, see [Account usage](/ui/account/usage).
\ No newline at end of file
diff --git a/ui/account/overview.mdx b/ui/account/overview.mdx
new file mode 100644
index 00000000..e47ba3cb
--- /dev/null
+++ b/ui/account/overview.mdx
@@ -0,0 +1,14 @@
+---
+title: Accounts overview
+sidebarTitle: Overview
+---
+
+import EnterpriseSelfHostedDifferences from '/snippets/general-shared-text/enterprise-self-hosted-differences.mdx';
+
+
+
+After you sign up for an Unstructured account, you can manage your account's [billing](/ui/account/billing) and
+get your account's [usage](/ui/account/usage) details.
+
+You can also create and manage your account's [API keys](/ui/account/api-key-url)—and get any [API URLs](/ui/account/api-key-url) as
+needed—to work programmatically with your Unstructured account through the [Unstructured API](/api-reference/overview).
\ No newline at end of file
diff --git a/ui/account/usage.mdx b/ui/account/usage.mdx
new file mode 100644
index 00000000..989ea9f6
--- /dev/null
+++ b/ui/account/usage.mdx
@@ -0,0 +1,30 @@
+---
+title: Account usage
+sidebarTitle: Usage
+---
+
+import EnterpriseSelfHostedDifferences from '/snippets/general-shared-text/enterprise-self-hosted-differences.mdx';
+
+
+
+To view usage details for your Unstructured account, do the following:
+
+
+
+
+
+
+
+1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io).
+2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.
+3. Click the **Usage History** tab.
+
+## How is usage calculated for billing purposes?
+
+import SharedPagesBilling from '/snippets/general-shared-text/pages-billing.mdx';
+
+
+
+The **Billing** tab shows your account's current billing rate per page.
+
+To complete billing-related tasks in your account, see [Account billing](/ui/account/billing).
\ No newline at end of file