diff --git a/api-reference/api-services/free-api.mdx b/api-reference/api-services/free-api.mdx index ada9269a..35e57711 100644 --- a/api-reference/api-services/free-api.mdx +++ b/api-reference/api-services/free-api.mdx @@ -3,7 +3,10 @@ title: Free Unstructured API description: This page describes how to obtain an API key to use with the free Unstructured API, the limitations of the free Unstructured API, and provides a quickstart example. --- -The Free Unstructured API is different than the free 14-day trial for the [Unstructured Serverless API](/api-reference/api-services/saas-api-development-guide). + + The Free Unstructured API is different than the free 14-day trial for the [Unstructured Serverless API](/api-reference/api-services/saas-api-development-guide) + or the free 14-day trial for the [Unstructured Platform API](/platform/api/overview). + ## Get an API key diff --git a/api-reference/api-services/overview.mdx b/api-reference/api-services/overview.mdx index 7deea4be..fa9caa2b 100644 --- a/api-reference/api-services/overview.mdx +++ b/api-reference/api-services/overview.mdx @@ -70,4 +70,4 @@ import SharedPagesBilling from '/snippets/general-shared-text/pages-billing.mdx' ## Get support -Should you require any assistance or have any questions regarding the Unstructured API, please contact our support team at [support@unstructured.io](mailto:support%40unstructured.io). +Should you require any assistance or have any questions regarding the Unstructured API, please [contact us directly](https://unstructured.io/contact). diff --git a/api-reference/api-services/saas-api-development-guide.mdx b/api-reference/api-services/saas-api-development-guide.mdx index 41a9ad06..5638ac51 100644 --- a/api-reference/api-services/saas-api-development-guide.mdx +++ b/api-reference/api-services/saas-api-development-guide.mdx @@ -1,57 +1,92 @@ --- title: Unstructured Serverless API -description: This page describes how to get started with the Unstructured Serverless API. Learn how to obtain an API key to use with the Unstructured Serverless API, and get started in no time. --- + + The Unstructured Serverless API is separate from the Unstructured Platform API. + + For information about the + Unstructured Platform API, see the [Unstructured Platform API Overview](/platform/api/overview). + + +This page describes how to get started with the Unstructured Serverless API. Learn how to obtain an API key to use with the Unstructured Serverless API, and get started in no time. + ## Get started -To call the Unstructured Serverless API, you need an API key and API URL: +To call the Unstructured Serverless API, you need an Unstructured account, API key, and API URL: - Go to the [For Developers](https://unstructured.io/developers) page and enter your information. + To sign up for an Unstructured account, go to the [For Developers](https://unstructured.io/developers) page and choose one of the following plans: + + - Sign up for a [pay-per-page plan](https://unstructured.io/developers#get-started). + - Save money by signing up for a [subscribe-and-save plan](https://unstructured.io/subscribeandsave) instead. + + If you're not sure which plan to sign up for, start with a [pay-per-page plan](https://unstructured.io/developers#get-started). You can always switch plans later. - By signing up through the [For Developers](https://unstructured.io/developers) page, your Unstructured account will run within the context of the Unstructured Platform on - Unstructured's own hosted cloud resources. Also, 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. You can always - start a prepaid subscription in exchange for usage rate discounts. To switch your account from a pay-as-you-go plan to a prepaid subscription, - contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + 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. - If you would rather run the Unstructured Platform within the context of your own virtual private cloud (VPC), - or you want to make a long-term billing commitment in exchange for deeply discounted service usage rates, + 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. + + By signing up for a pay-per-page or subscribe-and-save plan, your Unstructured account will run within the context of the Unstructured Platform on + Unstructured's own hosted cloud resources. If you would rather run the Unstructured Platform within the context of your own virtual private cloud (VPC), + (or you want to save even more money by making a long-term billing commitment), stop here and sign up through the [For Enterprise](https://unstructured.io/enterprise) page instead. - ![Sign in to your Unstructured account](/img/platform/Signin.png) - 1. After you have signed up through the [For Developers](https://unstructured.io/developers) page, the Unstructured Platform sign-in page appears. + + If you initially signed up for a subscribe-and-save plan instead of a pay-per-page plan, wait to complete this step until after you receive confirmation from Unstructured that your + plan is activated. Then go to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and click **Login**. - - If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your sign-in process will - be different. For enterprise sign-in guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - + If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your sign-in process will + be different. For enterprise sign-in guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + + 1. After you have signed up for a pay-per-page plan, the Unstructured Platform sign-in page appears. - 2. Click **Google** or **GitHub** to sign in with the Google or GitHub account that you signed up with through the **For Developers** page. + ![Sign in to your Unstructured account](/img/platform/Signin.png) + + 2. Click **Google** or **GitHub** to sign in with the Google or GitHub account that you signed up with. Or, enter the email address that you signed up with, and then click **Sign In**. 3. If you entered your email address, check your email inbox for a message from Unstructured. In that email, click the **Sign In** link. 4. The first time you sign in, read the terms and conditions, and then click **Accept**. - After you have signed in through the [For Developers](https://unstructured.io/developers) page for the first time, you can + After you have signed in for the first time, you can sign in the second time and beyond by going to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and clicking **Login**. For enterprise sign-in guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + ![Unstructured account settings](/img/platform/AccountSettings.png) - ![Unstructured API key and API URL](/img/platform/APIKeyURL.png) - 1. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. - 2. On the account settings sidebar, click **API Keys**, if it is not already selected. - 3. To get your API key, click the copy icon in the **Actions** column for your API key, and then click **Key Only**. Store your copied API key in a secure location. Do not share it with others. - 4. To get your API URL, click the copy icon next to the URL next to **API URL**. Store your copied API URL in a secure location. Do not share it with others. + ![Unstructured API key and API URL](/img/platform/APIKeyOnly.png) + + 1. After you have signed in to your Unstructured account, at the bottom of the sidebar, click your user icon, and then click **Account Settings**. + 2. On the **API Keys** tab, click **Generate New Key**. + 3. Enter some descriptive name for the API key, and then click **Save**. + 4. Click the **Copy** icon for your new API key. The API key's value is copied to your system's clipboard. + 5. Note the Unstructured **Serverless API URL**, which is `https://api.unstructuredapp.io/general/v0/general` + + ![Unstructured Serverless API URL](/img/platform/ServerlessAPIURL.png) + + + Do not use the Unstructured **Platform API URL**, which is separate from the Unstructured Serverless API URL. + + + + If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API URL + might be different. For API URL guidance, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + If your API URL is different, be sure to substitute `https://api.unstructuredapp.io/general/v0/general` for your + API URL throughout the following examples. + @@ -63,11 +98,11 @@ import ServerlessKeyNoFreeURL from '/snippets/general-shared-text/serverless-api ## Set up billing -Once you sign up for the Unstructured Serverless API through the [For Developers](https://unstructured.io/developers) page, you can enjoy a free 14-day trial with usage capped at 1000 pages per day. +If you signed up for a pay-per-page plan, you can enjoy a free 14-day trial with usage capped at 1000 pages per day. - If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your billing setup and terms will - be different. For enterprise billing guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + If you initially signed up for a subscribe-and-save plan instead, of if you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your billing setup and terms will + be different. For billing guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). The free 14-day trial for the Unstructured Serverless API is different than the [Free Unstructured API](/api-reference/api-services/free-api). @@ -77,20 +112,19 @@ the Unstructured Serverless API: ![Unstructured account settings](/img/platform/AccountSettings.png) -![Unstructured account billing](/img/platform/AccountBilling.png) +![Unstructured account payment method](/img/platform/AccountBillingPaymentMethod.png) 1. Sign in to the Unstructured Platform. 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. -3. On the account settings sidebar, click **Billing**. -4. Click **Manage Payment Method**, follow the on-screen instructions to enter your payment details through Stripe, and then click **Save card**. +3. Click the **Billing** tab. +4. Click **Manage Payment Method**, follow the on-screen instructions to enter or update your payment details, and then click **Save card**. Your card is billed monthly based on your usage. The **Billing** page shows a billing overview for the current month and a list of your billing invoices. - - You can always - start a prepaid subscription in exchange for usage rate discounts. To switch your account from a pay-as-you-go plan to a prepaid subscription, - contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - + + You can save money by switching from a pay-per-page plan to a subscribe-and-save plan. To do this, + go to the [Unstructured Subscribe & Save](https://unstructured.io/subscribeandsave) page and complete the on-screen instructions. + import SharedPagesBilling from '/snippets/general-shared-text/pages-billing.mdx'; @@ -168,35 +202,6 @@ import LocalToLocalPythonIngestLibrary from '/snippets/ingestion/local-to-local. After the command successfully runs, see the results in the specified output path on your local machine. -## Manage your account - -**To manage your account**: - -![Unstructured account settings](/img/platform/AccountSettings.png) - -1. Sign in to the Unstructured Platform. -2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. - -![Unstructured account settings sidebar](/img/platform/AccountSettingsSidebar.png) - -**To manage your API keys**: - -* On the account settings sidebar, click **API Keys**. -* To create a key, click **Generate New Key**, and follow the on-screen instructions. -* To enable or disable a key, switch **On/Off** in the column for that key to on or off. -* To delete a key, click the trash can in the **Actions** column for that key. - -**To view your usage**: On the account settings sidebar, click **Usage**. - -**To view your billing costs and invoices and to manage your payment method**: On the account settings sidebar, click **Billing**. - -**To log out of your account**: On the account settings sidebar, click your email address, and then click **Logout**. - -**To get help**: Our support team is just a text or email away: - -* On the account settings sidebar, click **Message Us**, or... -* Email us at [support@unstructured.io](mailto:support@unstructured.io). - ## Telemetry import SharedTelemetry from '/snippets/general-shared-text/telemetry.mdx'; diff --git a/api-reference/troubleshooting/api-key-url.mdx b/api-reference/troubleshooting/api-key-url.mdx index e9febc15..7bb0a1ea 100644 --- a/api-reference/troubleshooting/api-key-url.mdx +++ b/api-reference/troubleshooting/api-key-url.mdx @@ -1,11 +1,11 @@ --- -title: Troubleshooting Unstructured API keys and API URLs +title: Troubleshooting Unstructured API keys and URLs sidebarTitle: API keys and URLs --- ## Issue -When you run script or code to call Unstructured API services, you get the following error: +When you run script or code to call an Unstructured API, you get the following error: ``` UserWarning: If intending to use the paid API, please define `server_url` in your request. @@ -28,21 +28,27 @@ SDKError: API error occurred: Status 401 For the API URL, note the following: +- For the [Unstructured Platform API](/platform/api/overview), the API URL is typically `https://platform.unstructuredapp.io/api/v1`. - For the [Unstructured Serverless API](/api-reference/api-services/saas-api-development-guide), the API URL is typically `https://api.unstructuredapp.io/general/v0/general` (be aware of the inclusion of `app` in this API URL). - For the [Free Unstructured API](/api-reference/api-services/free-api), the API URL is always `https://api.unstructured.io/general/v0/general` (be aware that there is no `app` in this API URL). -The free 14-day trial of the Unstructured Serverless API is different than the Free Unstructured API. +The free 14-day trial of the Unstructured Serverless API or Unstructured Platform API is different than the Free Unstructured API. For the API key, note the following: -- For the [Unstructured Serverless API](/api-reference/api-services/saas-api-development-guide), the API key is in your dashboard. To access your dashboard: +- For the [Unstructured Serverless API](/api-reference/api-services/saas-api-development-guide) or the [Unstructured Platform API](/platform/api/overview), the API key is in your dashboard. To access your dashboard: - 1. Sign in to your Unstructured dashboard, at [https://app.unstructured.io](https://app.unstructured.io). - 2. On the sidebar, click **API Keys**. + ![Unstructured account settings](/img/platform/AccountSettings.png) + + 1. Sign in to your Unstructured account. + 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. + 3. On the **API Keys** tab, note the value of the Unstructured **Serverless API URL** or the Unstructured **Platform API URL**. + + ![Unstructured Serverless and Platform API URLs](/img/platform/ServerlessPlatformAPIURL.png) - For the [Free Unstructured API](/api-reference/api-services/free-api), the API key is in your original email from Unstructured. If you cannot find the original email, you can regenerate it by going to [https://unstructured.io/api-key-free](https://unstructured.io/api-key-free). -The free 14-day trial of the Unstructured Serverless API is different than the Free Unstructured API. +The free 14-day trial of the Unstructured Serverless API or Unstructured Platform API is different than the Free Unstructured API. If you still believe you have the correct API URL and API key, try the following steps: @@ -53,7 +59,7 @@ If you still believe you have the correct API URL and API key, try the following - Check the target URL. Make sure it is set to the right API URL. - Check the value of the `unstructured-api-key` header. Make sure it is set to the right API key, or an environment variable representing the right API key. - **For the Unstructured Python SDK** + **For the Unstructured Python SDK** (Unstructured Serverless API and Free Unstructured API only) - Check the value of the `UnstructuredClient` object's `server_url` or `server` parameter: @@ -68,7 +74,7 @@ If you still believe you have the correct API URL and API key, try the following - Check the value of the `UnstructuredClient` object's `api_key_auth` parameter. Make sure it is set to the right API key, or an environment variable representing the right API key. - **For the Unstructured JavaScript/TypeScript SDK** + **For the Unstructured JavaScript/TypeScript SDK** (Unstructured Serverless API and Free Unstructured API only) - Check the value of the `UnstructuredClient` object's `serverURL` or `server` parameter: @@ -83,12 +89,12 @@ If you still believe you have the correct API URL and API key, try the following - Check the value of the `UnstructuredClient` object's `security: { apiKeyAuth }` parameter. Make sure it is set to the right API key, or an environment variable representing the right API key. - **For the Unstructured Ingest CLI** + **For the Unstructured Ingest CLI** (Unstructured Serverless API and Free Unstructured API only) - Check the value of the `--partition-endpoint` command option. Make sure it is set to the right API URL, or an environment variable representing the right API URL. - Check the value of the `--api-key` command option. Make sure it is set to the right API key, or an environment variable representing the right API key. - **For the Unstructured Ingest Python library** + **For the Unstructured Ingest Python library** (Unstructured Serverless API and Free Unstructured API only) For a v2 connector implementation, check the value of the `partitioner_config` parameter in the `Pipeline.from_configs` method. This parameter should be set to a `PartitionerConfig` object: @@ -100,7 +106,7 @@ If you still believe you have the correct API URL and API key, try the following - Check the object's `partition_endpoint` parameter. Make sure it is set to the right API URL, or an environment variable representing the right API URL. - Check the object's `api_key` parameter. Make sure it is set to the right API key, or an environment variable representing the right API key. - **For the Unstructured open source library** + **For the Unstructured open source library** (Unstructured Serverless API and Free Unstructured API only) - Check the value of the `partition_by_api` command's `api_url` parameter. Make sure it is set to the right API URL, or an environment variable representing the right API URL. - Check the value of the `partition_by_api` command's `api_key` parameter. Make sure it is set to the right API key, or an environment variable representing the right API key. @@ -112,21 +118,26 @@ If you still believe you have the correct API URL and API key, try the following 3. Re-verify the API key and API URL that you want to use: - **For the Unstructured Serverless API** + **For the Unstructured Serverless API and Unstructured Platform API** + + ![Unstructured account settings](/img/platform/AccountSettings.png) - - Sign in to your Unstructured dashboard, at [https://app.unstructured.io](https://app.unstructured.io). - - On the sidebar, click **API Keys**. - - Make sure that the API key you want to use matches the one in your script, code, or environment variable. To get the full API key value, click the copy icon, and then click **Key Only**. Paste it to a temporary location for you to compare to your the one in your script, code, or environment variable. After you make the comparison, make sure to immediately delete from that temporary location what you just pasted. - - Make sure the API URL matches the one in your script, code, or environment variable. + 1. Sign in to your Unstructured account. + 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. + + - Make sure that the API key you want to use matches the one in your script, code, or environment variable. To get the full API key value, click the **Copy** icon. Paste it to a temporary location for you to compare to your the one in your script, code, or environment variable. After you make the comparison, make sure to immediately delete from that temporary location what you just pasted. + - Make sure the Unstructured **Serverless API URL** or the Unstructured **Platform API URL** matches the one in your script, code, or environment variable. + + ![Unstructured Serverless and Platform API URLs](/img/platform/ServerlessPlatformAPIURL.png) - You can use `"saas-api"` with the Unstructured SDKs, instead of an API URL. For more information, see Item 1 earlier in this section. + For the Unstructured Serverless API only, you can use `"saas-api"` with the Unstructured SDKs, instead of an API URL. For more information, see Item 1 earlier in this section. **For the Free Unstructured API** - Open your original email from Unstructured that contains your API key. Make sure it matches the one in your script, code, or environment variable. If you cannot find the original email, you can regenerate it by going to [https://unstructured.io/api-key-free](https://unstructured.io/api-key-free). - Make sure that you are using `https://api.unstructured.io/general/v0/general` (not `api.unstructuredapp.io`) for the API URL. - You can use `"free-api"` with the Unstructured SDKs, instead of an API URL. For more information, see Item 1 earlier in this section. + For the Free Unstructured API, you can use `"free-api"` with the Unstructured SDKs, instead of an API URL. For more information, see Item 1 earlier in this section. -4. If you are still getting this issue, contact Support by clicking the **Support** icon in the sidebar, or by emailing [support@unstructured.io](mailto:support@unstructured.io). +4. If you are still getting this issue, [contact us directly](https://unstructured.io/contact). diff --git a/faq/faq.mdx b/faq/faq.mdx index 92582cee..a2b135d2 100644 --- a/faq/faq.mdx +++ b/faq/faq.mdx @@ -4,4 +4,4 @@ url: "https://unstructured.io/developers#faq" icon: "question" --- -View our [frequently asked questions](https://unstructured.io/developers#faq). \ No newline at end of file +View our [frequently asked questions](https://unstructured.io/developers#faq). diff --git a/img/platform/APIKeyOnly.png b/img/platform/APIKeyOnly.png index 3190adce..4dc9d5ec 100644 Binary files a/img/platform/APIKeyOnly.png and b/img/platform/APIKeyOnly.png differ diff --git a/img/platform/AccountBillingPayPerPage.png b/img/platform/AccountBillingPayPerPage.png new file mode 100644 index 00000000..90e0447c Binary files /dev/null and b/img/platform/AccountBillingPayPerPage.png differ diff --git a/img/platform/AccountBillingPaymentMethod.png b/img/platform/AccountBillingPaymentMethod.png new file mode 100644 index 00000000..97527279 Binary files /dev/null and b/img/platform/AccountBillingPaymentMethod.png differ diff --git a/img/platform/AccountBillingSubscribeAndSave.png b/img/platform/AccountBillingSubscribeAndSave.png new file mode 100644 index 00000000..65d43db3 Binary files /dev/null and b/img/platform/AccountBillingSubscribeAndSave.png differ diff --git a/img/platform/AccountSettingsNeedHelp.png b/img/platform/AccountSettingsNeedHelp.png new file mode 100644 index 00000000..0fa92f9c Binary files /dev/null and b/img/platform/AccountSettingsNeedHelp.png differ diff --git a/img/platform/AccountUsage.png b/img/platform/AccountUsage.png new file mode 100644 index 00000000..8f3618a7 Binary files /dev/null and b/img/platform/AccountUsage.png differ diff --git a/img/platform/Job-Complete.png b/img/platform/Job-Complete.png index 66efa2c7..25875faf 100644 Binary files a/img/platform/Job-Complete.png and b/img/platform/Job-Complete.png differ diff --git a/img/platform/PlatformAPIURL.png b/img/platform/PlatformAPIURL.png new file mode 100644 index 00000000..7f094f0b Binary files /dev/null and b/img/platform/PlatformAPIURL.png differ diff --git a/img/platform/ServerlessAPIURL.png b/img/platform/ServerlessAPIURL.png new file mode 100644 index 00000000..6325da03 Binary files /dev/null and b/img/platform/ServerlessAPIURL.png differ diff --git a/img/platform/ServerlessPlatformAPIURL.png b/img/platform/ServerlessPlatformAPIURL.png new file mode 100644 index 00000000..17ae2317 Binary files /dev/null and b/img/platform/ServerlessPlatformAPIURL.png differ diff --git a/mint.json b/mint.json index 10e194cd..7c24d63b 100644 --- a/mint.json +++ b/mint.json @@ -19,9 +19,9 @@ }, "anchors": [ { - "name": "Support", + "name": "Contact Us", "icon": "person-circle-question", - "url": "mailto:support@unstructured.io" + "url": "https://unstructured.io/contact" }, { diff --git a/platform/api/overview.mdx b/platform/api/overview.mdx index 9959234d..a31174b2 100644 --- a/platform/api/overview.mdx +++ b/platform/api/overview.mdx @@ -2,6 +2,13 @@ title: Overview --- + + The Unstructured Platform API is separate from Unstructured Serverless API services. + + For information about Unstructured Serverless API services, see the + [Unstructured Serverless API services overview](/api-reference/api-services/overview). + + The [Unstructured Platform](/platform/overview) features a no-code user interface for transforming your unstructured data into data that is ready for Retrieval Augmented Generation (RAG). @@ -22,12 +29,12 @@ allowfullscreen To use the Unstructured Platform API, you must have: -- **An Unstructured account**, created through one of the following means: +- **An Unstructured account**, created through the [For Developers](https://unstructured.io/developers) page, with one of the following plans: - - The [For Developers](https://unstructured.io/developers) sign-up page. - - The [For Enterprise](https://unstructured.io/enterprise) sign-up page. + - A [pay-per-page plan](https://unstructured.io/developers#get-started). + - A [subscribe-and-save plan](https://unstructured.io/subscribeandsave) -- **An Unstructured API key**, created through the Unstructured account console. +- **An Unstructured API key**, created through your Unstructured account console. If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API key creation process @@ -40,19 +47,22 @@ To use the Unstructured Platform API, you must have: ![Unstructured account settings](/img/platform/AccountSettings.png) - ![Unstructured API key and API URL](/img/platform/APIKeyOnly.png) + ![Unstructured API key](/img/platform/APIKeyOnly.png) + 1. Sign in to the Unstructured Platform. [Learn how](/platform/quickstart). 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. - 3. On the account settings sidebar, click **API Keys**, if it is not already selected. - 4. To get your API key, click the copy icon in the **Actions** column for your API key, and then click **Key Only**. Do not share your API key with others. + 3. On the **API Keys** tab, click **Generate New Key**. + 4. Enter some descriptive name for the API key, and then click **Save**. + 5. Click the **Copy** icon for your new API key. The API key's value is copied to your system's clipboard. + +- The Unstructured **Platform API URL**, which is `https://platform.unstructuredapp.io/api/v1` + + ![Unstructured Platform API URL](/img/platform/PlatformAPIURL.png) - On the **Account Settings** page, do _not_ use the **API URL** value that is displayed. This API URL will _not_ work with the - Unstructured Platform API. See the next bullet for the Unstructured Platform API URL. + Do not use the Unstructured **Serverless API URL**, which is separate from the Unstructured Platform API URL. -- **The Unstructured Platform API URL**, which is `https://platform.unstructuredapp.io/api/v1` - If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API URL might be different. For API URL guidance, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). diff --git a/platform/billing.mdx b/platform/billing.mdx index dc3c7477..b333a75a 100644 --- a/platform/billing.mdx +++ b/platform/billing.mdx @@ -2,24 +2,75 @@ title: Billing --- -To ensure that your Unstructured account has continued access to the Unstructured Platform, you must have a current payment method -on file with Unstructured, as follows. +To ensure that your Unstructured account has continued access to the Unstructured Platform, 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. - To switch your account to a prepaid subscription or a long-term commitment plan, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io) instead. + 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). +## Add, view, or change pay-per-page payment details + +After you sign up for a [pay-per-page](https://unstructured.io/developers#get-started) plan, +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. + +![Unstructured account settings](/img/platform/AccountSettings.png) + +![Unstructured account payment method](/img/platform/AccountBillingPaymentMethod.png) + +1. Sign in to the Unstructured Platform. +2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. +3. Click the **Billing** tab. +4. Click **Manage Payment Method**, follow the on-screen instructions to enter or update your payment details, and then click **Save card**. + +## Switch from pay-per-page billing to a subscribe-and-save plan + +Go to the [Unstructured Subscribe & Save](https://unstructured.io/subscribeandsave) page and complete the on-screen instructions. + +## View pay-per-page billing details + +![Unstructured account settings](/img/platform/AccountSettings.png) + +![Unstructured account pay-per-page billing](/img/platform/AccountBillingPayPerPage.png) + +1. Sign in to the Unstructured Platform. +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. + +## View subscribe-and-save budget amounts + ![Unstructured account settings](/img/platform/AccountSettings.png) -![Unstructured account billing](/img/platform/AccountBilling.png) +![Unstructured account subscribe-and-save budget amounts](/img/platform/AccountBillingSubscribeAndSave.png) 1. Sign in to the Unstructured Platform. 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. -3. On the account settings sidebar, click **Billing**. -4. Click **Manage Payment Method**, follow the on-screen instructions to enter or update your payment details through Stripe, and then click **Save card**. +3. Click the **Billing** tab. The available and used budgets for your current plan are displayed. -Your card is billed monthly based on your usage. The **Billing** page shows a billing overview for the current month and a list of your billing invoices. +## Add budget to a subscribe-and-save plan + +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: + +![Unstructured account settings](/img/platform/AccountSettings.png) + +![Unstructured account billing usage](/img/platform/AccountUsage.png) + +1. Sign in to the Unstructured Platform. +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? import SharedPagesBilling from '/snippets/general-shared-text/pages-billing.mdx'; - \ No newline at end of file + + +The **Billing** tab shows your account's current billing rate per page. \ No newline at end of file diff --git a/platform/overview.mdx b/platform/overview.mdx index 8750ff0f..2895a84c 100644 --- a/platform/overview.mdx +++ b/platform/overview.mdx @@ -25,9 +25,10 @@ The Unstructured Platform is a no-code user interface, pay-as-you-go platform fo To get your data RAG-ready, the Unstructured Platform moves it through the following process: ```mermaid - flowchart LR - Connect[1. Connect]-->Route[2. Route]-->Transform[3. Transform]-->Chunk[4. Chunk]-->Enrich[5. Enrich]-->Embed[6. Embed]-->Persist[7. Persist] +flowchart LR + Connect-->Route-->Transform-->Chunk-->Enrich-->Embed-->Persist ``` + The Unstructured Platform offers multiple [source connectors](/platform/sources/overview) to connect to your data in its existing location. @@ -73,27 +74,30 @@ To get your data RAG-ready, the Unstructured Platform moves it through the follo -To simplify this process and provide it as a no-code solution, the Unstructured Platform brings together four key concepts: +To simplify this process and provide it as a no-code solution, the Unstructured Platform brings together these key concepts: ```mermaid - flowchart LR - subgraph Workflow[3. Workflow] - direction LR - Source[1. Source Connector] --> Destination[2. Destination Connector] - end - Jobs - Workflow[3. Workflow] --> Jobs[4. Jobs] +flowchart LR + + SC[Source Connectors] + DC[Destination Connectors] + W[Workflow] + J[Jobs] + + SC --> W + DC --> W + W --> J ``` - + [Source connectors](/platform/sources/overview) to ingest your data into the Unstructured Platform for transformation. - + [Destination connectors](/platform/destinations/overview) tell the Unstructured Platform where to write your transformed data to. - [Workflows](/platform/workflows) connect sources to destinations and provide chunking, embedding, and scheduling options. + A [workflow](/platform/workflows) connects sources to destinations and provide chunking, embedding, and scheduling options. [Jobs](/platform/jobs) enable you to monitor data transformation progress. @@ -110,16 +114,7 @@ Skip ahead to the [quickstart](/platform/quickstart). ## How do I get help? -We are just a text or email away! - -![Unstructured account settings](/img/platform/AccountSettings.png) - -![Unstructured account settings sidebar message us](/img/platform/AccountSettingsSidebarMessageUs.png) - -1. In the Unstructured Platform, at the bottom of the sidebar, click your user icon, and then click **Account Settings**. -2. On the account settings sidebar, click **Message Us**. - -Or, email us at [support@unstructured.io](mailto:support@unstructured.io). +[Contact us directly](https://unstructured.io/contact), or join our [Slack community](https://short.unstructured.io/pzw05l7). For enterprise support, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). diff --git a/platform/workflows.mdx b/platform/workflows.mdx index 4621f273..0daca516 100644 --- a/platform/workflows.mdx +++ b/platform/workflows.mdx @@ -35,9 +35,9 @@ To create an automatic workflow: 1. On the sidebar, click **Workflows**. 2. Click **New Workflow**. -3. Next to **Build it with me**, click **Create Workflow**. +3. Next to **Build it with Me**, click **Create Workflow**. - If a radio button appears instead of **Build it with me**, select it, and then click **Continue**. + If a radio button appears instead of **Build it with Me**, select it, and then click **Continue**. 4. For **Workflow Name**, enter some unique name for this workflow. 5. In the **Sources** dropdown list, select your source location. @@ -147,16 +147,15 @@ To create an automatic workflow: -9. The **Reprocess all** box applies only to blob storage connectors such as the Amazon S3, Azure Blob Storage, and Google Cloud Storage connectors: +9. The **Reprocess All** box applies only to blob storage connectors such as the Amazon S3, Azure Blob Storage, and Google Cloud Storage connectors: - Checking this box reprocesses all documents in the source location on every workflow run. - Unchecking this box causes only new documents that are added to the source location since the last workflow run to be processed on future runs. Previously processed documents are not processed again, even if those documents' contents change. -10. If you want to retry processing any documents that failed to process, check the **Retry Failed Documents** box. -11. Click **Continue**. -12. If you want this workflow to run on a schedule, in the **Repeat Run** dropdown list, select one of the scheduling options, and fill in the scheduling settings. Otherwise, select **Don't repeat**. -13. Click **Complete**. -14. If you did not set the workflow to run on a schedule, you can [run the worklow](#edit-delete-or-run-a-workflow) now. +10. Click **Continue**. +11. If you want this workflow to run on a schedule, in the **Repeat Run** dropdown list, select one of the scheduling options, and fill in the scheduling settings. Otherwise, select **Don't repeat**. +12. Click **Complete**. +13. If you did not set the workflow to run on a schedule, you can [run the worklow](#edit-delete-or-run-a-workflow) now. ### Create a custom workflow @@ -170,7 +169,7 @@ To create an automatic workflow: 1. On the sidebar, click **Workflows**. 2. Click **New Workflow**. -3. Click the **Build it myself** option, and then click **Continue**. +3. Click the **Build it Myself** option, and then click **Continue**. 4. In the **This workflow** pane, click the **Details** button. ![Workflow details](/img/platform/Workflow-Details.png) @@ -179,7 +178,7 @@ To create an automatic workflow: 6. If you want this workflow to run on a schedule, click the **Schedule** button. In the **Repeat Run** dropdown list, select one of the scheduling options, and fill in the scheduling settings. 7. To overwrite any previously processed files, or to retry any documents that fail to process, click the **Settings** button, and check either or both of the boxes. - The **Reprocess all** box applies only to blob storage connectors such as the Amazon S3, Azure Blob Storage, and Google Cloud Storage connectors: + The **Reprocess All** box applies only to blob storage connectors such as the Amazon S3, Azure Blob Storage, and Google Cloud Storage connectors: - Checking this box reprocesses all documents in the source location on every workflow run. - Unchecking this box causes new documents that have been added to the source location, as well as existing documents in the source location that have had their contents or titles changed, since the last workflow run to be processed on future runs. Other previously processed documents are not processed again. diff --git a/snippets/general-shared-text/api-key-differences.mdx b/snippets/general-shared-text/api-key-differences.mdx index bf7ba581..638f6d69 100644 --- a/snippets/general-shared-text/api-key-differences.mdx +++ b/snippets/general-shared-text/api-key-differences.mdx @@ -1,5 +1,12 @@ -Unstructured Serverless API keys do not work with the [Free Unstructured API](/api-reference/api-services/free-api). If you try to use a Serverless API key with a Free API URL, the call will fail. [Get a Serverless API key and its related Serverless API URL](/api-reference/api-services/saas-api-development-guide#get-started). + Unstructured API keys and API URLs are not fully interchangeable: -Free Unstructured API keys do not work with the [Unstructured Serverless API](/api-reference/api-services/saas-api-development-guide). If you try to use a Free API key with a Serverless API URL, the call will fail. [Get a Free API key and its related Free API URL](/api-reference/api-services/free-api#get-an-api-key). + - Unstructured Serverless API keys and Unstructured Platform API keys do not work with the Free Unstructured API](/api-reference/api-services/free-api). + - Free Unstructured API keys do not work with the [Unstructured Serverless API](/api-reference/api-services/saas-api-development-guide) or the [Unstructured Platform API](/platform/api/overview). + + To get the correct API key and URL, do one of the following: + + - Get an [Unstructured Serverless API key and API URL](/api-reference/api-services/saas-api-development-guide). + - Get a [Free Unstructured API key and API URL](/api-reference/api-services/free-api). + - Get an [Unstructured Platform API key and API URL](/platform/api/overview). \ No newline at end of file diff --git a/snippets/general-shared-text/free-api-key-no-serverless-access.mdx b/snippets/general-shared-text/free-api-key-no-serverless-access.mdx index 9bcc9fcc..b69df5d8 100644 --- a/snippets/general-shared-text/free-api-key-no-serverless-access.mdx +++ b/snippets/general-shared-text/free-api-key-no-serverless-access.mdx @@ -1,3 +1,8 @@ -Free Unstructured API keys do not work with the [Unstructured Serverless API](/api-reference/api-services/saas-api-development-guide). If you try to use a Free Unstructured API key with an Unstructured Serverless API URL, the call will fail. Use your Free Unstructured API URL instead. + Free Unstructured API keys do not work with the [Unstructured Serverless API](/api-reference/api-services/saas-api-development-guide) or the [Unstructured Platform API](/platform/api/overview). + + To get the correct API key and URL, do one of the following: + + - Get an [Unstructured Serverless API key and API URL](/api-reference/api-services/saas-api-development-guide). + - Get an [Unstructured Platform API key and API URL](/platform/api/overview). \ No newline at end of file diff --git a/snippets/quickstarts/platform.mdx b/snippets/quickstarts/platform.mdx index 74e7ab54..e62a07b3 100644 --- a/snippets/quickstarts/platform.mdx +++ b/snippets/quickstarts/platform.mdx @@ -18,36 +18,49 @@ allowfullscreen - To sign up for the Unstructured Platform, go to the [For Developers](https://unstructured.io/developers) page and enter your information. + To sign up for the Unstructured Platform, go to the [For Developers](https://unstructured.io/developers) page and choose one of the following plans: + + - Sign up for a [pay-per-page plan](https://unstructured.io/developers#get-started). + - Save money by signing up for a [subscribe-and-save plan](https://unstructured.io/subscribeandsave) instead. + + If you're not sure which plan to sign up for, start with a [pay-per-page plan](https://unstructured.io/developers#get-started). You can always switch plans later. - By signing up through the [For Developers](https://unstructured.io/developers) page, your Unstructured account will run within the context of the Unstructured Platform on - Unstructured's own hosted cloud resources. Also, 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. You can always - start a prepaid subscription in exchange for usage rate discounts. To switch your account from a pay-as-you-go plan to a prepaid subscription, - contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + 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](/platform/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. + To save even more money by making a long-term billing commitment, + stop here and sign up through the [For Enterprise](https://unstructured.io/enterprise) page instead. - If you would rather run the Unstructured Platform within the context of your own virtual private cloud (VPC), - or you want to make a long-term billing commitment in exchange for deeply discounted service usage rates, + By signing up for a pay-per-page or subscribe-and-save plan, your Unstructured account will run within the context of the Unstructured Platform on + Unstructured's own hosted cloud resources. If you would rather run the Unstructured Platform within the context of your own virtual private cloud (VPC), stop here and sign up through the [For Enterprise](https://unstructured.io/enterprise) page instead. - ![Sign in to your Unstructured account](/img/platform/Signin.png) - 1. After you have signed up through the [For Developers](https://unstructured.io/developers) page, the Unstructured Platform sign-in page appears. + + If you initially signed up for a subscribe-and-save plan instead of a pay-per-page plan, wait to complete this step until after you receive confirmation from Unstructured that your + plan is activated. Then go to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and click **Login**. + + If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your sign-in process will + be different. For enterprise sign-in guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + - - If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your sign-in process will - be different. For enterprise sign-in guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - + 1. After you have signed up for a pay-per-page plan, the Unstructured Platform sign-in page appears. - 2. Click **Google** or **GitHub** to sign in with the Google or GitHub account that you signed up with through the **For Developers** page. + ![Sign in to your Unstructured account](/img/platform/Signin.png) + + 2. Click **Google** or **GitHub** to sign in with the Google or GitHub account that you signed up with. Or, enter the email address that you signed up with, and then click **Sign In**. 3. If you entered your email address, check your email inbox for a message from Unstructured. In that email, click the **Sign In** link. 4. The first time you sign in, read the terms and conditions, and then click **Accept**. - After you have signed in through the [For Developers](https://unstructured.io/developers) page for the first time, you can + After you have signed in for the first time, you can sign in the second time and beyond by going to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and clicking **Login**. For enterprise sign-in guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). @@ -81,9 +94,9 @@ allowfullscreen ![Workflows in the sidebar](/img/platform/Workflows-Sidebar.png) 1. In the sidebar, click **Workflows**. 2. Click **New Workflow**. - 3. Next to **Build it with me**, click **Create Workflow**. + 3. Next to **Build it with Me**, click **Create Workflow**. - If a radio button appears instead of **Build it with me**, select it, and then click **Continue**. + If a radio button appears instead of **Build it with Me**, select it, and then click **Continue**. 4. For **Workflow Name**, enter some unique name for this workflow. 5. In the **Sources** dropdown list, select your source location from Step 3. @@ -104,15 +117,14 @@ allowfullscreen these files are processed. These errors typically occur when these larger PDF files have lots of tables and high-resolution images. - 9. The **Reprocess all** box applies only to blob storage connectors such as the Amazon S3, Azure Blob Storage, and Google Cloud Storage connectors: + 9. The **Reprocess All** box applies only to blob storage connectors such as the Amazon S3, Azure Blob Storage, and Google Cloud Storage connectors: - Checking this box reprocesses all documents in the source location on every workflow run. - Unchecking this box causes new documents that have been added to the source location, as well as existing documents in the source location that have had their contents or titles changed, since the last workflow run to be processed on future runs. Other previously processed documents are not processed again. - 10. If you want to retry processing any documents that failed to process, check the **Retry Failed Documents** box. - 11. Click **Continue**. - 12. If you want this workflow to run on a schedule, in the **Repeat Run** dropdown list, select one of the scheduling options, and fill in the scheduling settings. Otherwise, select **Don't repeat**. - 13. Click **Complete**. + 10. Click **Continue**. + 11. If you want this workflow to run on a schedule, in the **Repeat Run** dropdown list, select one of the scheduling options, and fill in the scheduling settings. Otherwise, select **Don't repeat**. + 12. Click **Complete**. ![Workflows in the sidebar](/img/platform/Workflows-Sidebar.png) @@ -125,7 +137,7 @@ allowfullscreen 1. In the sidebar, click **Jobs**. 2. In the list of jobs, wait for the job's **Status** to change to **Finished**. 3. Click the row for the job. - 4. If **Overview** displays **Success**, go to the next Step. + 4. After **Overview** displays **Finished**, go to the next Step. Go to your destination location to view the processed data. diff --git a/welcome.mdx b/welcome.mdx index 211767af..cf52ca04 100644 --- a/welcome.mdx +++ b/welcome.mdx @@ -107,23 +107,32 @@ The requirements are as follows. - Go to the [For Developers](https://unstructured.io/developers) page and enter your information. + Sign up for an Unstructured account by going to the [For Developers](https://unstructured.io/developers) page and choosing one of the following plans: + + - Sign up for a [pay-per-page plan](https://unstructured.io/developers#get-started). + - Save money by signing up for a [subscribe-and-save plan](https://unstructured.io/subscribeandsave) instead. + + If you're not sure which plan to sign up for, start with a [pay-per-page plan](https://unstructured.io/developers#get-started). You can always switch plans later. By signing up through the [For Developers](https://unstructured.io/developers) page, your Unstructured account will run within the context of the Unstructured Platform on - Unstructured's own hosted cloud resources. Also, 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. You can always - start a prepaid subscription in exchange for usage rate discounts. To switch your account from a pay-as-you-go plan to a prepaid subscription, - contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + Unstructured's own hosted cloud resources. + + 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. You must provide + Unstructured with your payment details to keep using the service. + + 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. - If you would rather run the Unstructured Platform within the context of your own virtual private cloud (VPC), + If you would rather use Unstructured within the context of your own virtual private cloud (VPC), or you want to make a long-term billing commitment in exchange for deeply discounted service usage rates, stop here and sign up through the [For Enterprise](https://unstructured.io/enterprise) page instead. ![Sign in to your Unstructured account](/img/platform/Signin.png) - 1. After you have signed up through the [For Developers](https://unstructured.io/developers) page, the Unstructured Platform sign-in page appears. + 1. After you have signed up through the [For Developers](https://unstructured.io/developers) page, the Unstructured account sign-in page appears. If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your sign-in process will @@ -140,7 +149,7 @@ The requirements are as follows. ![Unstructured API key and API URL](/img/platform/APIKeyURL.png) 1. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. - 2. On the account settings sidebar, click **API Keys**, if it is not already selected. + 2. Click the **API Keys** tab, if it is not already selected. 3. To get your API key, click the copy icon in the **Actions** column for your API key, and then click **Key Only**. Store your copied API key in a secure location. Do not share it with others. 4. To get your API URL, click the copy icon next to the URL next to **API URL**. Store your copied API URL in a secure location. Do not share it with others. @@ -175,5 +184,5 @@ The requirements are as follows. ## Get in touch If you can't find the information you're looking for in the documentation, or if you need help, -get in touch with our Support team at [support@unstructured.io](mailto:support%40unstructured.io), +[contact us directly](https://unstructured.io/contact), or [join our Slack](https://short.unstructured.io/pzw05l7) where our team and community can help you.