Skip to content

[Hold] Account updates #713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Aug 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api-reference/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ import Pricing from '/snippets/general-shared-text/pricing-platform.mdx';

## Get support

Should you require any assistance or have any questions regarding the Unstructured API, please [contact us directly](https://unstructured.io/contact).
For technical support for Unstructured accounts, email Unstructured Support at [[email protected]](mailto:support@unstructured.io).

## Learn more

Expand Down
2 changes: 1 addition & 1 deletion api-reference/partition/examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ representing your Unstructured API key. [Get your API key](/api-reference/partit

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).
If you do not have this API URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).

<Note>
For the Unstructured Python SDK, the API URL is set to `https://api.unstructuredapp.io/general/v0/general` by default.
Expand Down
2 changes: 1 addition & 1 deletion api-reference/partition/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ available for download from [https://constitutioncenter.org/media/files/constitu
From your terminal or Command Prompt, set the following two environment variables.

- Replace `<your-unstructured-api-url>` 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).
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).

<Note>
The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`.
Expand Down
6 changes: 3 additions & 3 deletions api-reference/partition/post-requests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s
<GetStartedSimpleAPIOnly/>

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).
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).

<Note>
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.
The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`.
However, you should always use the API URL that was provided to you when your Unstructured account was created.
</Note>

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.
Expand Down
10 changes: 10 additions & 0 deletions api-reference/partition/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ title: Unstructured API Quickstart

<Tip>Just need to copy the sample code? [Skip ahead](#sample-code) to it now!</Tip>

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/0EogKNU_BPU"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

The following code shows how to use the [Unstructured Python SDK](/api-reference/partition/sdk-python)
to have Unstructured process one or more local files by using
the [Unstructured Partition Endpoint](/api-reference/partition/overview).
Expand Down
55 changes: 27 additions & 28 deletions api-reference/troubleshooting/api-key-url.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ API error occurred: Status 404
## Suggested solutions

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 do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).

<Note>
The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`.
Expand All @@ -48,45 +48,44 @@ If you do not have this URL, contact Unstructured Sales at [[email protected]

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:

1. Sign in to your Unstructured account:
1. If you are not already signed in, sign in to your Unstructured **Starter** or **Team** account at [https://platform.unstructured.io](https://platform.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, 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 [[email protected]](mailto:[email protected]).
<Note>
For an **Enterprise** account, see your Unstructured account administrator for instructions,
or email Unstructured Support at [[email protected]](mailto:[email protected]).
</Note>

2. Get your Unstructured API key:
2. Get your Unstructured API key:<br/>

a. In the Unstructured UI, click **API Keys** on the sidebar.<br/>
b. Click the **Copy** icon next to your target key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.<br/>

3. If you want or need to generate a new Unstructured API key at this point:
a. After you sign in to your Unstructured **Starter** account, click **API Keys** on the sidebar.<br/>

a. Click **Generate API Key**.<br/>
b. Follow the on-screen instructions to finish generating the key.<br/>
c. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.<br/>
<Note>
For a **Team** or **Enterprise** account, before you click **API Keys**, make sure you have selected the organizational workspace you want to create an API key
for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace).
</Note>

<Note>
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, the process for getting your API key
might be different. For guidance, email Unstructured Sales at [[email protected]](mailto:[email protected]).
</Note>
b. Click **Generate API Key**.<br/>
c. Follow the on-screen instructions to finish generating the key.<br/>
d. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.<br/>

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. Sign in to your Unstructured account:
1. If you are not already signed in, sign in to your Unstructured **Starter** or **Team** account at [https://platform.unstructured.io](https://platform.unstructured.io).

<Note>
For an **Enterprise** account, see your Unstructured account administrator for instructions,
or email Unstructured Support at [[email protected]](mailto:[email protected]).
</Note>

2. After you sign in to your Unstructured **Starter** account, click **API Keys** on the sidebar.<br/>

- 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 [[email protected]](mailto:[email protected]).
<Note>
For a **Team** or **Enterprise** account, before you click **API Keys**, make sure you have selected the organizational workspace you want to get the API URL for.
</Note>

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.

<Note>
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 [[email protected]](mailto:[email protected]).
</Note>

If you still believe you have the correct API URL and API key, try the following steps:

1. Check your script or code to see where the API URL and API key are specified, as follows:
Expand Down Expand Up @@ -116,5 +115,5 @@ If you still believe you have the correct API URL and API key, try the following
- Run the command for your operating system to list all environment variables. Make sure the API key and API URL are listed and are set to the right ones. Make sure the names and cases of these environment variables match the ones in your script or code exactly.
- If you use an integrated development environment (IDE) to run your script or code, check the IDE's documentation for how to specify and load environment variables at run time or debug time. Make sure the names and cases of these environment variables match the ones in your script or code exactly.

3. If you are still getting this issue, [contact us directly](https://unstructured.io/contact).
3. If you are still getting this issue, email Unstructured Support at [[email protected]](mailto:support@unstructured.io).

6 changes: 3 additions & 3 deletions api-reference/workflow/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ 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.
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 do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).

<Note>
The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`.
Expand Down Expand Up @@ -131,7 +131,7 @@ utilities, tools, programming languages, packages, and libraries. The examples,
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).
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).
</Tip>

### curl and Postman
Expand All @@ -144,7 +144,7 @@ export UNSTRUCTURED_API_KEY="<your-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).
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).

<Note>
The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`.
Expand Down
43 changes: 26 additions & 17 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -299,39 +299,39 @@
]
},
{
"tab": "Self-hosted",
"tab": "Enterprise",
"groups": [
{
"group": "Self-hosting",
"group": "Enterprise",
"pages": [
"self-hosted/overview"
"enterprise/overview"
]
},
{
"group": "Security and compliance",
"pages": [
"self-hosted/security-compliance/overview"
"enterprise/security-compliance/overview"
]
},
{
"group": "AWS",
"pages": [
"self-hosted/aws/overview",
"self-hosted/aws/onboard"
"enterprise/aws/overview",
"enterprise/aws/onboard"
]
},
{
"group": "Azure",
"pages": [
"self-hosted/azure/overview",
"self-hosted/azure/onboard"
"enterprise/azure/overview",
"enterprise/azure/onboard"
]
},
{
"group": "GCP",
"pages": [
"self-hosted/gcp/overview",
"self-hosted/gcp/onboard"
"enterprise/gcp/overview",
"enterprise/gcp/onboard"
]
}
]
Expand Down Expand Up @@ -524,12 +524,12 @@
"global": {
"anchors": [
{
"anchor": "Contact Us",
"href": "https://unstructured.io/contact",
"anchor": "Account support (e-mail)",
"href": "mailto:support@unstructured.io",
"icon": "person-circle-question"
},
{
"anchor": "Community",
"anchor": "Open source support (Slack)",
"href": "https://short.unstructured.io/pzw05l7",
"icon": "slack"
},
Expand All @@ -544,28 +544,33 @@
"icon": "newspaper"
},
{
"anchor": "Product",
"anchor": "Product info",
"href": "https://unstructured.io/",
"icon": "square-terminal"
},
{
"anchor": "Trust Portal",
"anchor": "Trust portal",
"href": "https://trust.unstructured.io/",
"icon": {
"name": "file-certificate",
"style": "thin"
}
},
{
"anchor": "Meta-Prompt (Titles)",
"anchor": "Contact Sales (e-mail)",
"href": "mailto:[email protected]",
"icon": "person"
},
{
"anchor": "Meta-prompt (titles)",
"href": "https://docs.unstructured.io/llms.txt",
"icon": {
"name": "microchip-ai",
"style": "thin"
}
},
{
"anchor": "Meta-Prompt (Full)",
"anchor": "Meta-prompt (full)",
"href": "https://docs.unstructured.io/llms-full.txt",
"icon": {
"name": "microchip-ai",
Expand Down Expand Up @@ -749,6 +754,10 @@
"source": "/platform-api/partition-api/:slug*",
"destination": "/api-reference/partition/:slug*"
},
{
"source": "/self-hosted/:slug*",
"destination": "/enterprise/:slug*"
},
{
"source": "/ui/billing",
"destination": "/ui/account/billing"
Expand Down
14 changes: 6 additions & 8 deletions self-hosted/aws/onboard.mdx → enterprise/aws/onboard.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
---
title: AWS self-hosted onboarding checklist
title: Unstructured Enterprise in-VPC on Amazon Web Services (AWS) - onboarding checklist
sidebarTitle: Onboarding
---

<Note>
To proceed with a self-hosted deployment, your organization must first sign a self-hosting agreement with Unstructured.
The following information applies only to in-VPC deployments of [Unstructured Enterprise](/enterprise/overview).

If you have not yet signed this agreement, stop here, and begin the self-hosting agreement process by contacting your Unstructured sales representative, emailing
Unstructured Sales at [[email protected]](mailto:[email protected]), or filling out the [contact form](https://unstructured.io/contact)
on the Unstructured website.
For dedicated instance deployments of Unstructured Enterprise, contact your Unstructured sales representative,
or email Unstructured Sales at [[email protected]](mailto:[email protected]).
</Note>

After your organization has signed the self-hosting agreement with Unstructured, a member of the Unstructured technical enablement team will reach out to you to begin the
After your organization has signed the Enterprise agreement with Unstructured, a member of the Unstructured technical enablement team will reach out to you to begin the
deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. Choose one of the following setup options:

- [Do it all for me](#do-it-all-for-me): Have Unstructured set up the required infrastructure in your AWS account and then deploy the Unstructured UI and API into that newly created infrastructure.
Expand All @@ -20,8 +19,7 @@ deployment onboarding process. To streamline this process, you are encouraged to
## Questions? Need help?

If you have questions or need help as you go, contact your Unstructured sales representative or technical enablement contact. If you do not know who they are,
email Unstructured Sales at [[email protected]](mailto:[email protected]), or fill out the
[contact form](https://unstructured.io/contact) on the Unstructured website, and a member of the Unstructured sales or technical enablement teams
email Unstructured Sales at [[email protected]](mailto:[email protected]), and a member of the Unstructured sales or technical enablement teams
will get back to you as soon as possible.

## Do it all for me
Expand Down
27 changes: 27 additions & 0 deletions enterprise/aws/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Unstructured Enterprise in-VPC on Amazon Web Services (AWS) - overview
sidebarTitle: Overview
---

<Note>
The following information applies only to in-VPC deployments of [Unstructured Enterprise](/enterprise/overview).

For dedicated instance deployments of Unstructured Enterprise, contact your Unstructured sales representative,
or email Unstructured Sales at [[email protected]](mailto:[email protected]).
</Note>

## Getting started

To get started with an Enterpise deployment, your organization must first sign an Enterprise agreement with Unstructured.
This agreement outlines the terms and conditions for your organization to use Unstructured.

To begin the Enterprise agreement process, contact your Unstructured sales representative, or email Unstructured Sales at [[email protected]](mailto:[email protected]).

After your organization has signed the Enterprise agreement, a member of the Unstructured technical enablement team will reach out to you to begin the
deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this,
see the [onboarding checkist](/enterprise/aws/onboard).

## Questions? Need help?

Contact your Unstructured sales representative, or email Unstructured Sales at [[email protected]](mailto:[email protected]), and a member of the Unstructured sales or support teams
will get back to you as soon as possible.
Loading