diff --git a/api-reference/partition/examples.mdx b/api-reference/partition/examples.mdx index 11fddfbd..2d77df1c 100644 --- a/api-reference/partition/examples.mdx +++ b/api-reference/partition/examples.mdx @@ -6,11 +6,14 @@ description: This page provides some examples of accessing Unstructured Partitio To use these examples, you'll first need to set an environment variable named `UNSTRUCTURED_API_KEY`, representing your Unstructured API key. [Get your API key](/api-reference/partition/overview). -For the POST and Unstructured JavaScript/TypeScript SDK examples, you'll also need to set an environment variable named `UNSTRUCTURED_API_URL` to the -value `https://api.unstructuredapp.io/general/v0/general` - -For the Unstructured Python SDK, you do not need to set an environment variable named `UNSTRUCTURED_API_URL`, as the Python SDK uses the API URL of -`https://api.unstructuredapp.io/general/v0/general` by default. (The Unstructured JavaScript/TypeScript SDK does not have this feature yet; you must always specify the API URL.) +Also, you'll need to set an environment variable named `UNSTRUCTURED_API_URL` to the +value of the Unstructured API URL for your account. This API URL was provided to you when your Unstructured account was created. +If you do not have this API URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + + For the Unstructured Python SDK, the API URL is set to `https://api.unstructuredapp.io/general/v0/general` by default. + However, you should always use the API URL that was provided to you when your Unstructured account was created. + ### Changing partition strategy for a PDF diff --git a/api-reference/partition/overview.mdx b/api-reference/partition/overview.mdx index c3b2145c..73b1cb11 100644 --- a/api-reference/partition/overview.mdx +++ b/api-reference/partition/overview.mdx @@ -35,7 +35,14 @@ available for download from [https://constitutioncenter.org/media/files/constitu From your terminal or Command Prompt, set the following two environment variables. - - Replace `` with the Unstructured Partition Endpoint URL, which is `https://api.unstructuredapp.io/general/v0/general` + - Replace `` with the Unstructured Partition Endpoint URL. This URL was provided to you when your Unstructured account was created. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + + The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`. + However, you should always use the URL that was provided to you when your Unstructured account was created. + + - Replace `` with your Unstructured API key, which you generated earlier on this page. ```bash diff --git a/api-reference/partition/post-requests.mdx b/api-reference/partition/post-requests.mdx index 379f91e0..25b6209c 100644 --- a/api-reference/partition/post-requests.mdx +++ b/api-reference/partition/post-requests.mdx @@ -29,7 +29,13 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s -The API URL is `https://api.unstructuredapp.io/general/v0/general` +The API URL was provided to you when your Unstructured account was created. +If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + + The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`. However, + this URL might not necessarily work for your account. + Let's start with a simple example in which you use [curl](https://curl.se/) to send a local PDF file (`*.pdf`) to partition via the Unstructured Partition Endpoint. diff --git a/api-reference/troubleshooting/api-key-url.mdx b/api-reference/troubleshooting/api-key-url.mdx index 9b78b95e..d226c823 100644 --- a/api-reference/troubleshooting/api-key-url.mdx +++ b/api-reference/troubleshooting/api-key-url.mdx @@ -35,16 +35,15 @@ API error occurred: Status 404 ## Suggested solutions -For the API URL, note the following: - -- For the [Unstructured Workflow Endpoint](/api-reference/workflow/overview), the typical API URL is `https://platform.unstructuredapp.io/api/v1`. This is also - the default API URL that Unstructured Python SDK uses for the Workflow Endpoint. -- For the [Unstructured Partition Endpoint](/api-reference/partition/overview), the default API URL is `https://api.unstructuredapp.io/general/v0/general`. This is also - the default API URL that Unstructured Python SDK uses for the Partition Endpoint. +For the API URL, this URL was provided to you when your Unstructured account was created. +If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, of if you are using a [self-hosted](/self-hosted/overview) deployment of Unstructured, your API URL - might be different. For guidance, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`. + + The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`. + + However, you should always use the URLs that were provided to you when your Unstructured account was created. For the API key, the same API key works for both the [Unstructured Workflow Endpoint](/api-reference/workflow/overview) and the [Unstructured Partition Endpoint](/api-reference/partition/overview). To access your key: @@ -52,8 +51,8 @@ For the API key, the same API key works for both the [Unstructured Workflow Endp 1. Sign in to your Unstructured account: - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, go to [https://platform.unstructured.io](https://platform.unstructured.io) and sign in by using the email address, Google account, - or GitHub account that is associated with your Unstructured account. The Unstructured user interface (UI) then appears, and you can start using it right away. + - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). 2. Get your Unstructured API key: @@ -73,8 +72,12 @@ For the API key, the same API key works for both the [Unstructured Workflow Endp For the API URL, note the value of the Unstructured API URL for the Endpoint that you want to call. To access these API URLs: -1. Go to [https://platform.unstructured.io](https://platform.unstructured.io) and sign in by using the email address, Google account, - or GitHub account that is associated with your Unstructured account. The Unstructured user interface (UI) appears. +1. Sign in to your Unstructured account: + + - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. + - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + 2. In the Unstructured UI, click **API Keys** on the sidebar. 3. Note the API URL for the **Unstructured Workflow Endpoint** or the **Unstructured Partition Endpoint**, depending on whether you want to call the [Unstructured Workflow Endpoint](/api-reference/workflow/overview) or the [Unstructured Partition Endpoint](/api-reference/partition/overview), respectively. diff --git a/api-reference/workflow/overview.mdx b/api-reference/workflow/overview.mdx index 129206fb..ef816478 100644 --- a/api-reference/workflow/overview.mdx +++ b/api-reference/workflow/overview.mdx @@ -89,18 +89,17 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s Calls made by the Unstructured Python SDK's `unstructured_client` functions for creating, listing, updating, -and deleting connectors, workflows, and jobs in the Unstructured UI all use the Unstructured Workflow Endpoint URL (`https://platform.unstructuredapp.io/api/v1`) by default. You do not need to -use the `server_url` parameter to specify this API URL in your Python code for these particular functions. +and deleting connectors, workflows, and jobs in the Unstructured UI all use the Unstructured Workflow Endpoint URL. +This URL was provided to you when your Unstructured account was created. +If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API URL and API key creation guidance - might be different. For guidance, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - If your API URL is different, be sure to substitute `https://platform.unstructuredapp.io/api/v1` for your - API URL throughout the following examples. - - To specify an API URL in your code, set the `server_url` parameter in the `UnstructuredClient` constructor to the target API URL. + The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`. + However, you should always use the URL that was provided to you when your Unstructured account was created. +To specify an API URL in your code, set the `server_url` parameter in the `UnstructuredClient` constructor to the target API URL. + The Unstructured Workflow Endpoint enables you to work with [connectors](#connectors), [workflows](#workflows), and [jobs](#jobs) in the Unstructured UI. @@ -128,8 +127,11 @@ utilities, tools, programming languages, packages, and libraries. The examples, You can also use the [Unstructured Workflow Endpoint - Swagger UI](https://platform.unstructuredapp.io/docs) to call the REST endpoints - that are available through `https://platform.unstructuredapp.io`. To use the Swagger UI, you must provide your Unstructured API key with each call. To + that are available through the default Unstructured Workflow Endpoint URL: `https://platform.unstructuredapp.io`. To use the Swagger UI, you must provide your Unstructured API key with each call. To get this API key, see the [quickstart](#quickstart), earlier on this page. + + Note that you should always use the URL that was provided to you when your Unstructured account was created. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). ### curl and Postman @@ -141,6 +143,14 @@ export UNSTRUCTURED_API_URL="https://platform.unstructuredapp.io/api/v1" export UNSTRUCTURED_API_KEY="" ``` +For the API URL, this URL was provided to you when your Unstructured account was created. +If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + + The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`. + However, you should always use the URL that was provided to you when your Unstructured account was created. + + These environment variables enable you to more easily run the following `curl` examples and help prevent you from storing scripts that contain sensitive URLs and API keys in public source code repositories. @@ -156,8 +166,8 @@ The following Postman examples use variables, which you can set as follows: - **Variable**: `UNSTRUCTURED_API_URL` - **Type**: `default` - - **Initial value**: `https://platform.unstructuredapp.io/api/v1` - - **Current value**: `https://platform.unstructuredapp.io/api/v1` + - **Initial value**: The Unstructured Workflow Endpoint URL that was provided to you when your Unstructured account was created. + - **Current value**: The Unstructured Workflow Endpoint URL that was provided to you when your Unstructured account was created.
- **Variable**: `UNSTRUCTURED_API_KEY` - **Type**: `secret` @@ -225,7 +235,7 @@ The following Unstructured SDKs, tools, and libraries do _not_ work with the Uns - The [Unstructured Ingest CLI](/open-source/ingestion/ingest-cli) - The [Unstructured Ingest Python library](/open-source/ingestion/python-ingest) -The following Unstructured API URL is also _not_ supported: `https://api.unstructuredapp.io/general/v0/general` (the Unstructured Partition Endpoint URL). +The following Unstructured API URL is also _not_ supported: `https://api.unstructuredapp.io/general/v0/general` (the default Unstructured Partition Endpoint URL). ## Connectors diff --git a/open-source/ingestion/ingest-cli.mdx b/open-source/ingestion/ingest-cli.mdx index 64f441a7..09c029af 100644 --- a/open-source/ingestion/ingest-cli.mdx +++ b/open-source/ingestion/ingest-cli.mdx @@ -23,16 +23,13 @@ Using the Ingest CLI to send files in batches to Unstructured for processing is -3. The default Unstructured API URL for Unstructured Ingest is `https://api.unstructuredapp.io/general/v0/general`, which is the API URL for the [Unstructured Partition Endpoint](/api-reference/partition/overview). - You must specify this API URL in your - scripts only if you are not using this default, for example, if you are calling a version of the Unstructured API that is hosted on your own compute infrastructure. +3. The Unstructured API URL for Unstructured Ingest was provided to you when your Unstructured account was created. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - - If the Unstructured API is hosted on your own compute infrastructure, the process - for generating Unstructured API keys, and the Unstructured API URL that you use, are different. - For details, contact Unstructured Sales at - [sales@unstructured.io](mailto:sales@unstructured.io). - + + The default URL for Unstructured Ingest is the same as the default URL for the Unstructured Partition Endpoint: `https://api.unstructuredapp.io/general/v0/general`. + However, you should always use the URL that was provided to you when your Unstructured account was created. + ## Installation diff --git a/open-source/ingestion/python-ingest.mdx b/open-source/ingestion/python-ingest.mdx index fe20ac28..360e5907 100644 --- a/open-source/ingestion/python-ingest.mdx +++ b/open-source/ingestion/python-ingest.mdx @@ -35,16 +35,13 @@ Using the Ingest Python library to send files in batches to Unstructured for pro -3. The default Unstructured API URL for Unstructured Ingest is `https://api.unstructuredapp.io/general/v0/general`, which is the API URL for the [Unstructured Partition Endpoint](/api-reference/partition/overview). - You must specify this API URL in your - code only if you are not using this default, for example, if you are calling a version of the Unstructured API that is hosted on your own compute infrastructure. +3. The Unstructured API URL for Unstructured Ingest was provided to you when your Unstructured account was created. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - - If the Unstructured API is hosted on your own compute infrastructure, the process - for generating Unstructured API keys, and the Unstructured API URL that you use, are different. - For details, contact Unstructured Sales at - [sales@unstructured.io](mailto:sales@unstructured.io). - + + The default URL for Unstructured Ingest is the same as the default URL for the Unstructured Partition Endpoint: `https://api.unstructuredapp.io/general/v0/general`. + However, you should always use the URL that was provided to you when your Unstructured account was created. + ## Installation diff --git a/snippets/general-shared-text/first-time-api-destination-connector.mdx b/snippets/general-shared-text/first-time-api-destination-connector.mdx index 00505828..425da3a6 100644 --- a/snippets/general-shared-text/first-time-api-destination-connector.mdx +++ b/snippets/general-shared-text/first-time-api-destination-connector.mdx @@ -4,9 +4,9 @@ Before you can create a destination connector, you must first sign in to your Unstructured account: - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, go to [https://platform.unstructured.io](https://platform.unstructured.io) and sign in by using the email address, Google account, - or GitHub account that is associated with your Unstructured account. - + - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to get your Unstructured API key. To learn how, watch this 40-second [how-to video](https://www.youtube.com/watch?v=FucugLkYB6M). diff --git a/snippets/general-shared-text/first-time-api-source-connector.mdx b/snippets/general-shared-text/first-time-api-source-connector.mdx index 1d1eedc4..8662aa8c 100644 --- a/snippets/general-shared-text/first-time-api-source-connector.mdx +++ b/snippets/general-shared-text/first-time-api-source-connector.mdx @@ -4,9 +4,9 @@ Before you can create a source connector, you must first sign in to your Unstructured account: - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, go to [https://platform.unstructured.io](https://platform.unstructured.io) and sign in by using the email address, Google account, - or GitHub account that is associated with your Unstructured account. - + - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to get your Unstructured API key. To learn how, watch this 40-second [how-to video](https://www.youtube.com/watch?v=FucugLkYB6M). diff --git a/snippets/general-shared-text/first-time-ui-destination-connector.mdx b/snippets/general-shared-text/first-time-ui-destination-connector.mdx index b8c60d92..cee6a383 100644 --- a/snippets/general-shared-text/first-time-ui-destination-connector.mdx +++ b/snippets/general-shared-text/first-time-ui-destination-connector.mdx @@ -4,9 +4,9 @@ Before you can create a destination connector, you must first sign in to your Unstructured account: - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, go to [https://platform.unstructured.io](https://platform.unstructured.io) and sign in by using the email address, Google account, - or GitHub account that is associated with your Unstructured account. - + - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to create your destination connector. After you create the destination connector, add it along with a diff --git a/snippets/general-shared-text/first-time-ui-source-connector.mdx b/snippets/general-shared-text/first-time-ui-source-connector.mdx index 23e52032..467a2bec 100644 --- a/snippets/general-shared-text/first-time-ui-source-connector.mdx +++ b/snippets/general-shared-text/first-time-ui-source-connector.mdx @@ -4,8 +4,8 @@ Before you can create a source connector, you must first sign in to your Unstructured account: - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, go to [https://platform.unstructured.io](https://platform.unstructured.io) and sign in by using the email address, Google account, - or GitHub account that is associated with your Unstructured account. + - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to create your source connector. diff --git a/snippets/general-shared-text/get-started-simple-api-only.mdx b/snippets/general-shared-text/get-started-simple-api-only.mdx index 35bb63f4..69424eca 100644 --- a/snippets/general-shared-text/get-started-simple-api-only.mdx +++ b/snippets/general-shared-text/get-started-simple-api-only.mdx @@ -1,13 +1,8 @@ - - If you signed up for Unstructured through the [For Enterprise](https://unstructured.io/enterprise) page, or if you are using a [self-hosted](/self-hosted/overview) deployment of Unstructured, the following information - about signing up, signing in, and getting your Unstructured API key might apply differently to you. For details, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - - 1. Sign in to your Unstructured account: - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, go to [https://platform.unstructured.io](https://platform.unstructured.io) and sign in by using the email address, Google account, - or GitHub account that is associated with your Unstructured account. The Unstructured user interface (UI) then appears, and you can start using it right away. + - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. After you sign in, the Unstructured user interface (UI) then appears, and you can start using it right away. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). 2. Get your Unstructured API key: diff --git a/snippets/general-shared-text/get-started-simple-ui-only.mdx b/snippets/general-shared-text/get-started-simple-ui-only.mdx index 933a7d63..f6ef8ec5 100644 --- a/snippets/general-shared-text/get-started-simple-ui-only.mdx +++ b/snippets/general-shared-text/get-started-simple-ui-only.mdx @@ -1,8 +1,3 @@ - - If you signed up for Unstructured through the [For Enterprise](https://unstructured.io/enterprise) page, or if you are using a [self-hosted](/self-hosted/overview) deployment of Unstructured, the following sign up information - does not apply to you, and you can skip ahead to the next step after you sign in. If you are not sure how to sign in, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - - - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. -- If you already have an Unstructured account, go to [https://platform.unstructured.io](https://platform.unstructured.io) and sign in by using the email address, Google account, - or GitHub account that is associated with your Unstructured account. The Unstructured user interface (UI) then appears, and you can start using it right away. \ No newline at end of file +- If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. After you sign in, the Unstructured user interface (UI) then appears, and you can start using it right away. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). \ No newline at end of file diff --git a/snippets/general-shared-text/pricing-platform.mdx b/snippets/general-shared-text/pricing-platform.mdx index 931a7cb3..a77a5d4a 100644 --- a/snippets/general-shared-text/pricing-platform.mdx +++ b/snippets/general-shared-text/pricing-platform.mdx @@ -1,7 +1,7 @@ Unstructured offers three account pricing plans: - **SaaS Cloud-hosted** - Processing happens on Unstructured's software-as-a-service (SaaS) cloud infrastructure in a multi-tenant environment. -- **Hybrid SaaS** - Processing also happens on Unstructured's SaaS cloud infrastructure, but your data stays protected in a dedicated cloud environment, maintaining strict data privacy. +- **Private SaaS** - Processing also happens on Unstructured's SaaS cloud infrastructure, but your data stays protected in a dedicated cloud environment, maintaining strict data privacy. - **VPC** - Sometimes referred to as [self-hosted](/self-hosted/overview), an instance of the Unstructured SaaS is deployed into your own virtual private cloud (VPC), providing complete data ownership and infrastructure control, full customization, and dedicated technical support. For more details, see the [Unstructured Pricing](https://unstructured.io/pricing) page. diff --git a/snippets/ingest-configuration-shared/chunking-configuration.mdx b/snippets/ingest-configuration-shared/chunking-configuration.mdx index 41694e57..03be606d 100644 --- a/snippets/ingest-configuration-shared/chunking-configuration.mdx +++ b/snippets/ingest-configuration-shared/chunking-configuration.mdx @@ -21,6 +21,6 @@ A common chunking configuration is a critical element in the data processing pip * `chunk_overlap_all`: Applies overlap to chunks formed from whole elements as well as those formed by text-splitting oversized elements. The overlap length is taken from the `chunk_overlap` value. -* `chunking_endpoint`: If `chunk_by_api` is set to `True`, chunking requests are sent to this Unstructured API URL. By default, this URL is the Unstructured Partition Endpoint URL: `https://api.unstructuredapp.io/general/v0/general`. +* `chunking_endpoint`: If `chunk_by_api` is set to `True`, chunking requests are sent to this Unstructured API URL. By default, this URL is the Unstructured Partition Endpoint URL: `https://api.unstructuredapp.io/general/v0/general`. However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). * `chunking_strategy`: One of `basic` or `by_title`. When omitted, no chunking is performed. The `basic` strategy maximally fills each chunk with whole elements, up the specified size limits as specified by `max_characters` and `new_after_n_chars`. A single element that exceeds this length is divided into two or more chunks using text-splitting. A `Table` element is never combined with any other element and appears as a chunk of its own or as a sequence of `TableChunk` elements splitting is required. The `by_title` behaviors are the same except that section and optionally page boundaries are respected such that two consecutive elements from different sections appear in separate chunks. \ No newline at end of file diff --git a/snippets/ingest-configuration-shared/partition-by-api-oss.mdx b/snippets/ingest-configuration-shared/partition-by-api-oss.mdx index 6ab16e81..c25d6585 100644 --- a/snippets/ingest-configuration-shared/partition-by-api-oss.mdx +++ b/snippets/ingest-configuration-shared/partition-by-api-oss.mdx @@ -19,7 +19,7 @@ For the Unstructured Ingest CLI and the Unstructured Ingest Python library, you You must specify the API URL only if you are not using the default API URL for Unstructured Ingest, for example, if you are using a [self-hosted](/self-hosted/overview) instance of the Unstructured API. - The default API URL for Unstructured Ingest is `https://api.unstructuredapp.io/general/v0/general`, which is the API URL for the [Unstructured Partition Endpoint](/api-reference/partition/overview). + The default API URL for Unstructured Ingest is `https://api.unstructuredapp.io/general/v0/general`, which is the API URL for the [Unstructured Partition Endpoint](/api-reference/partition/overview). However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). If you do not have an API key, [get one now](/api-reference/partition/overview). diff --git a/snippets/quickstarts/single-file-ui.mdx b/snippets/quickstarts/single-file-ui.mdx index f830d0e6..23ed06c6 100644 --- a/snippets/quickstarts/single-file-ui.mdx +++ b/snippets/quickstarts/single-file-ui.mdx @@ -159,7 +159,12 @@ import EnrichmentImagesTablesHiResOnly from '/snippets/general-shared-text/enric 1. With your workflow remaining open in the visual workflow editor, open a new tab in your web browser, and in this new tab, - sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). + sign in to your Unstructured account: + + - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. + - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. + If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + 2. In this new tab, create a [source connector](/ui/sources/overview) for your remote source location. This is the location in production where you have files or data in a file or object store, website, database, or vector store that you want Unstructured to process. ![Connectors button on the sidebar](/img/ui/Sources-Sidebar.png) diff --git a/ui/account/api-key-url.mdx b/ui/account/api-key-url.mdx index 1a0071da..6ca0a669 100644 --- a/ui/account/api-key-url.mdx +++ b/ui/account/api-key-url.mdx @@ -3,10 +3,6 @@ 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 @@ -22,13 +18,13 @@ 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). +1. Sign in to your Unstructured account. 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). +1. Sign in to 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**. @@ -40,7 +36,7 @@ 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). +1. 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. @@ -53,7 +49,7 @@ If you are concerned that an unauthorized user or other entity might have this A 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). +1. 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, switch the **Status** toggle on or off for the target API key to enable or disable that key, respectively. @@ -76,7 +72,7 @@ To rotate an old, existing API key before you permanently delete it: To permanently delete an existing API key: -1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). +1. 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 **Options** vertical ellipsis for the target API key. 4. Click **Delete**. @@ -88,6 +84,6 @@ In some cases, you might need to specify a particular API URL to call one of 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). +1. Sign in to your Unstructured account. 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/account/billing.mdx b/ui/account/billing.mdx index dfe4bf77..13fab4bf 100644 --- a/ui/account/billing.mdx +++ b/ui/account/billing.mdx @@ -3,10 +3,6 @@ title: Account billing sidebarTitle: Billing --- -import EnterpriseSelfHostedDifferences from '/snippets/general-shared-text/enterprise-self-hosted-differences.mdx'; - - - ## Add, view, or change payment details ![Unstructured account settings](/img/ui/AccountSettings.png) @@ -15,7 +11,7 @@ import EnterpriseSelfHostedDifferences from '/snippets/general-shared-text/enter Unstructured billing how-to -1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). +1. Sign in to your Unstructured account. 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**. @@ -28,7 +24,7 @@ import EnterpriseSelfHostedDifferences from '/snippets/general-shared-text/enter Unstructured billing how-to -1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). +1. Sign in to your Unstructured account. 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. diff --git a/ui/account/organizations.mdx b/ui/account/organizations.mdx index e024a93b..16547db9 100644 --- a/ui/account/organizations.mdx +++ b/ui/account/organizations.mdx @@ -149,8 +149,7 @@ sales representative, email Unstructured Sales at [sales@unstructured.io](mailto ## Access an organizational account -1. Depending on the location of the organizational account that you want to access, sign in to [https://platform.unstructured.io](https://platform.unstructured.io), - or sign in by using the URL for your organization's [self-hosted](/self-hosted/overview) deployment of Unstructured. +1. Sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that you want to access. If the organizational account selector is not shown, or if the selector does not show the organizational account you want to access, then @@ -164,8 +163,7 @@ sales representative, email Unstructured Sales at [sales@unstructured.io](mailto To add a user to an organizational account as a member: -1. Depending on the location of the organizational account that you want to access, sign in to [https://platform.unstructured.io](https://platform.unstructured.io), - or sign in by using the URL for your organization's [self-hosted](/self-hosted/overview) deployment of Unstructured. +1. Sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that you want to add the member to. 3. In the sidebar, above your user icon, click the **Settings** (gear) icon. 4. Click **Manage Account**. @@ -181,8 +179,7 @@ To add a user to an organizational account as a member: Your user must have the **Super Admin** role in the organizational account to change its members' organizational account roles. -1. Depending on the location of the organizational account that you want to access, sign in to [https://platform.unstructured.io](https://platform.unstructured.io), - or sign in by using the URL for your organization's [self-hosted](/self-hosted/overview) deployment of Unstructured. +1. Sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the member you want to change roles for. 3. In the sidebar, above your user icon, click the **Settings** (gear) icon. 4. Click **Manage Account**. @@ -208,8 +205,7 @@ To add a user to an organizational account as a member: Your user must have the **Super Admin** [role](/ui/account/roles) in the organizational account to remove members from that organizational account. -1. Depending on the location of the organizational account that you want to access, sign in to [https://platform.unstructured.io](https://platform.unstructured.io), - or sign in by using the URL for your organization's [self-hosted](/self-hosted/overview) deployment of Unstructured. +1. Sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that you want to remove the member from. 3. In the sidebar, above your user icon, click the **Settings** (gear) icon. 4. Click **Manage Account**. diff --git a/ui/account/overview.mdx b/ui/account/overview.mdx index b62d7b50..2c5094dd 100644 --- a/ui/account/overview.mdx +++ b/ui/account/overview.mdx @@ -3,10 +3,6 @@ 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. diff --git a/ui/account/usage.mdx b/ui/account/usage.mdx index 989ea9f6..84038fd0 100644 --- a/ui/account/usage.mdx +++ b/ui/account/usage.mdx @@ -3,10 +3,6 @@ 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: ![Unstructured account settings](/img/ui/AccountSettings.png) @@ -15,7 +11,7 @@ To view usage details for your Unstructured account, do the following: Unstructured billing how-to -1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). +1. Sign in to your Unstructured account. 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. 3. Click the **Usage History** tab. diff --git a/ui/account/workspaces.mdx b/ui/account/workspaces.mdx index 46199e52..37a03c00 100644 --- a/ui/account/workspaces.mdx +++ b/ui/account/workspaces.mdx @@ -109,8 +109,7 @@ sales representative, email Unstructured Sales at [sales@unstructured.io](mailto (A user always has one and only one personal workspace within their personal account. You cannot create additional workspaces in personal accounts.) -1. Depending on the location of the organizational account that you want to access, sign in to [https://platform.unstructured.io](https://platform.unstructured.io), - or sign in by using the URL for your organization's [self-hosted](/self-hosted/overview) deployment of Unstructured. +1. Sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that you want to add a workspace to. 3. In the sidebar, above your user icon, click the **Settings** (gear) icon. 4. Click **View All Workspaces**. @@ -127,8 +126,7 @@ sales representative, email Unstructured Sales at [sales@unstructured.io](mailto ## Access a workspace -1. Depending on the location of the organizational account that you want to access, sign in to [https://platform.unstructured.io](https://platform.unstructured.io), - or sign in by using the URL for your organization's [self-hosted](/self-hosted/overview) deployment of Unstructured. +1. Sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to access. 3. In the workspace selector, select the name of the workspace that you want to access. @@ -151,8 +149,7 @@ To add a user to a workspace as a member: 1. Make sure the account user that you want to add has already been added as a member of the workspace's parent organizational account. [Learn how](/ui/account/organizations#add-a-member-to-an-organization). -2. Depending on the location of the organizational account that you want to access, sign in to [https://platform.unstructured.io](https://platform.unstructured.io), - or sign in by using the URL for your organization's [self-hosted](/self-hosted/overview) deployment of Unstructured. +2. Sign in to your Unstructured account. 3. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to add a member to. 4. In the workspace selector, select the name of the workspace that you want to add a member to. 5. In the sidebar, above your user icon, click the **Settings** (gear) icon. @@ -170,8 +167,7 @@ To add a user to a workspace as a member: workspace to change the roles for that workspace's members. -1. Depending on the location of the organizational account that you want to access, sign in to [https://platform.unstructured.io](https://platform.unstructured.io), - or sign in by using the URL for your organization's [self-hosted](/self-hosted/overview) deployment of Unstructured. +1. Sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace for the member you want to change roles for. 3. In the workspace selector, select the name of the workspace that contains the member you want to change roles for. 4. In the sidebar, above your user icon, click the **Settings** (gear) icon. @@ -199,8 +195,7 @@ To add a user to a workspace as a member: (A user cannot be removed from their personal workspace within their personal account.) -1. Depending on the location of the organizational account that you want to access, sign in to [https://platform.unstructured.io](https://platform.unstructured.io), - or sign in by using the URL for your organization's [self-hosted](/self-hosted/overview) deployment of Unstructured. +1. Sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to remove a member from. 3. In the workspace selector, select the name of the workspace that you want to remove a member from. 4. In the sidebar, above your user icon, click the **Settings** (gear) icon. @@ -221,8 +216,7 @@ To make programmatic API calls to a workspace instead of using the UI, an API ke An API key can be used only with the workspace for which it was created. -1. Depending on the location of the organizational account that you want to access, sign in to [https://platform.unstructured.io](https://platform.unstructured.io), - or sign in by using the URL for your organization's [self-hosted](/self-hosted/overview) deployment of Unstructured. +1. Sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to create an API key for. 3. In the workspace selector, select the name of the workspace that you want to create an API key for. 4. In the sidebar, above your user icon, click the **Settings** (gear) icon. @@ -248,8 +242,7 @@ An API key is valid only for the workspace for which it was created. workspace to delete API keys from that workspace. -1. Depending on the location of the organizational account that you want to access, sign in to [https://platform.unstructured.io](https://platform.unstructured.io), - or sign in by using the URL for your organization's [self-hosted](/self-hosted/overview) deployment of Unstructured. +1. Sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to delete an API key for. 3. In the workspace selector, select the name of the workspace that you want to delete an API key for. 4. In the sidebar, above your user icon, click the **Settings** (gear) icon.