You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-reference/partition/overview.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ available for download from [https://constitutioncenter.org/media/files/constitu
36
36
From your terminal or Command Prompt, set the following two environment variables.
37
37
38
38
- Replace `<your-unstructured-api-url>` with the Unstructured Partition Endpoint URL. This URL was provided to you when your Unstructured account was created.
39
-
If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
39
+
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).
40
40
41
41
<Note>
42
42
The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`.
Copy file name to clipboardExpand all lines: api-reference/partition/post-requests.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,11 +30,11 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s
30
30
<GetStartedSimpleAPIOnly/>
31
31
32
32
The API URL was provided to you when your Unstructured account was created.
33
-
If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
33
+
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).
34
34
35
35
<Note>
36
-
The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`. However,
37
-
this URL might not necessarily work for your account.
36
+
The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`.
37
+
However, you should always use the API URL that was provided to you when your Unstructured account was created.
38
38
</Note>
39
39
40
40
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.
Copy file name to clipboardExpand all lines: api-reference/troubleshooting/api-key-url.mdx
+27-28Lines changed: 27 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ API error occurred: Status 404
36
36
## Suggested solutions
37
37
38
38
For the API URL, this URL was provided to you when your Unstructured account was created.
39
-
If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
39
+
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).
40
40
41
41
<Note>
42
42
The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`.
@@ -48,45 +48,44 @@ If you do not have this URL, contact Unstructured Sales at [[email protected]
48
48
49
49
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:
50
50
51
-
1.Sign in to your Unstructured account:
51
+
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).
52
52
53
-
- 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.
54
-
- 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.
a. In the Unstructured UI, click **API Keys** on the sidebar.<br/>
60
-
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/>
61
-
62
-
3. If you want or need to generate a new Unstructured API key at this point:
60
+
a. After you sign in to your Unstructured **Starter** account, click **API Keys** on the sidebar.<br/>
63
61
64
-
a. Click **Generate API Key**.<br/>
65
-
b. Follow the on-screen instructions to finish generating the key.<br/>
66
-
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/>
62
+
<Note>
63
+
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
64
+
for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace).
65
+
</Note>
67
66
68
-
<Note>
69
-
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
c. Follow the on-screen instructions to finish generating the key.<br/>
69
+
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/>
72
70
73
71
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:
74
72
75
-
1. Sign in to your Unstructured account:
73
+
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).
74
+
75
+
<Note>
76
+
For an **Enterprise** account, see your Unstructured account administrator for instructions,
2. After you sign in to your Unstructured **Starter** account, click **API Keys** on the sidebar.<br/>
76
81
77
-
- 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.
78
-
- 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.
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.
84
+
</Note>
80
85
81
-
2. In the Unstructured UI, click **API Keys** on the sidebar.
82
86
3. Note the API URL for the **Unstructured Workflow Endpoint** or the **Unstructured Partition Endpoint**, depending on whether you want to call the
83
87
[Unstructured Workflow Endpoint](/api-reference/workflow/overview) or the [Unstructured Partition Endpoint](/api-reference/partition/overview), respectively.
84
88
85
-
<Note>
86
-
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
If you still believe you have the correct API URL and API key, try the following steps:
91
90
92
91
1. Check your script or code to see where the API URL and API key are specified, as follows:
@@ -116,5 +115,5 @@ If you still believe you have the correct API URL and API key, try the following
116
115
- 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.
117
116
- 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.
118
117
119
-
3. If you are still getting this issue, [contact us directly](https://unstructured.io/contact).
118
+
3. If you are still getting this issue, email Unstructured Support at [[email protected]](mailto:support@unstructured.io).
Copy file name to clipboardExpand all lines: enterprise/aws/onboard.mdx
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,16 @@
1
1
---
2
-
title: AWS self-hosted onboarding checklist
2
+
title: Unstructured Enterprise in-VPC on Amazon Web Services (AWS) - onboarding checklist
3
3
sidebarTitle: Onboarding
4
4
---
5
5
6
6
<Note>
7
-
To proceed with a self-hosted deployment, your organization must first sign a self-hosting agreement with Unstructured.
7
+
The following information applies only to in-VPC deployments of [Unstructured Enterprise](/enterprise/overview).
8
8
9
-
If you have not yet signed this agreement, stop here, and begin the self-hosting agreement process by contacting your Unstructured sales representative, emailing
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
13
+
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
15
14
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:
16
15
17
16
-[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.
@@ -20,8 +19,7 @@ deployment onboarding process. To streamline this process, you are encouraged to
20
19
## Questions? Need help?
21
20
22
21
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,
To get started with an Enterpise deployment, your organization must first sign an Enterprise agreement with Unstructured.
16
+
This agreement outlines the terms and conditions for your organization to use Unstructured.
17
+
18
+
To begin the Enterprise agreement process, contact your Unstructured sales representative, or email Unstructured Sales at [[email protected]](mailto:[email protected]).
19
+
20
+
After your organization has signed the Enterprise agreement, a member of the Unstructured technical enablement team will reach out to you to begin the
21
+
deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this,
22
+
see the [onboarding checkist](/enterprise/aws/onboard).
23
+
24
+
## Questions? Need help?
25
+
26
+
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
0 commit comments