Skip to content

Commit 184dbec

Browse files
authored
Pricing and URL updates (#649)
1 parent c9a98a6 commit 184dbec

23 files changed

+116
-125
lines changed

api-reference/partition/examples.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,14 @@ description: This page provides some examples of accessing Unstructured Partitio
66
To use these examples, you'll first need to set an environment variable named `UNSTRUCTURED_API_KEY`,
77
representing your Unstructured API key. [Get your API key](/api-reference/partition/overview).
88

9-
For the POST and Unstructured JavaScript/TypeScript SDK examples, you'll also need to set an environment variable named `UNSTRUCTURED_API_URL` to the
10-
value `https://api.unstructuredapp.io/general/v0/general`
11-
12-
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
13-
`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.)
9+
Also, you'll need to set an environment variable named `UNSTRUCTURED_API_URL` to the
10+
value of the Unstructured API URL for your account. This API URL was provided to you when your Unstructured account was created.
11+
If you do not have this API URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
12+
13+
<Note>
14+
For the Unstructured Python SDK, the API URL is set to `https://api.unstructuredapp.io/general/v0/general` by default.
15+
However, you should always use the API URL that was provided to you when your Unstructured account was created.
16+
</Note>
1417

1518
### Changing partition strategy for a PDF
1619

api-reference/partition/overview.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,14 @@ available for download from [https://constitutioncenter.org/media/files/constitu
3535
<Step title="Set environment variables">
3636
From your terminal or Command Prompt, set the following two environment variables.
3737

38-
- Replace `<your-unstructured-api-url>` with the Unstructured Partition Endpoint URL, which is `https://api.unstructuredapp.io/general/v0/general`
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 [[email protected]](mailto:[email protected]).
40+
41+
<Note>
42+
The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`.
43+
However, you should always use the URL that was provided to you when your Unstructured account was created.
44+
</Note>
45+
3946
- Replace `<your-unstructured-api-key>` with your Unstructured API key, which you generated earlier on this page.
4047

4148
```bash

api-reference/partition/post-requests.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,13 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s
2929

3030
<GetStartedSimpleAPIOnly/>
3131

32-
The API URL is `https://api.unstructuredapp.io/general/v0/general`
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 [[email protected]](mailto:[email protected]).
34+
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.
38+
</Note>
3339

3440
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.
3541

api-reference/troubleshooting/api-key-url.mdx

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,25 +35,24 @@ API error occurred: Status 404
3535

3636
## Suggested solutions
3737

38-
For the API URL, note the following:
39-
40-
- For the [Unstructured Workflow Endpoint](/api-reference/workflow/overview), the typical API URL is `https://platform.unstructuredapp.io/api/v1`. This is also
41-
the default API URL that Unstructured Python SDK uses for the Workflow Endpoint.
42-
- For the [Unstructured Partition Endpoint](/api-reference/partition/overview), the default API URL is `https://api.unstructuredapp.io/general/v0/general`. This is also
43-
the default API URL that Unstructured Python SDK uses for the Partition Endpoint.
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 [[email protected]](mailto:[email protected]).
4440

4541
<Note>
46-
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
47-
might be different. For guidance, email Unstructured Sales at [[email protected]](mailto:[email protected]).
42+
The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`.
43+
44+
The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`.
45+
46+
However, you should always use the URLs that were provided to you when your Unstructured account was created.
4847
</Note>
4948

5049
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:
5150

5251
1. Sign in to your Unstructured account:
5352

5453
- 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.
55-
- 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,
56-
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.
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.
55+
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
5756

5857
2. Get your Unstructured API key:
5958

@@ -73,8 +72,12 @@ For the API key, the same API key works for both the [Unstructured Workflow Endp
7372

7473
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:
7574

76-
1. Go to [https://platform.unstructured.io](https://platform.unstructured.io) and sign in by using the email address, Google account,
77-
or GitHub account that is associated with your Unstructured account. The Unstructured user interface (UI) appears.
75+
1. Sign in to your Unstructured account:
76+
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.
79+
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
80+
7881
2. In the Unstructured UI, click **API Keys** on the sidebar.
7982
3. Note the API URL for the **Unstructured Workflow Endpoint** or the **Unstructured Partition Endpoint**, depending on whether you want to call the
8083
[Unstructured Workflow Endpoint](/api-reference/workflow/overview) or the [Unstructured Partition Endpoint](/api-reference/partition/overview), respectively.

api-reference/workflow/overview.mdx

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -89,18 +89,17 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s
8989
<GetStartedSimpleAPIOnly/>
9090

9191
Calls made by the Unstructured Python SDK's `unstructured_client` functions for creating, listing, updating,
92-
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
93-
use the `server_url` parameter to specify this API URL in your Python code for these particular functions.
92+
and deleting connectors, workflows, and jobs in the Unstructured UI all use the Unstructured Workflow Endpoint URL.
93+
This URL was provided to you when your Unstructured account was created.
94+
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
9495

9596
<Note>
96-
If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API URL and API key creation guidance
97-
might be different. For guidance, email Unstructured Sales at [[email protected]](mailto:[email protected]).
98-
If your API URL is different, be sure to substitute `https://platform.unstructuredapp.io/api/v1` for your
99-
API URL throughout the following examples.
100-
101-
To specify an API URL in your code, set the `server_url` parameter in the `UnstructuredClient` constructor to the target API URL.
97+
The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`.
98+
However, you should always use the URL that was provided to you when your Unstructured account was created.
10299
</Note>
103100

101+
To specify an API URL in your code, set the `server_url` parameter in the `UnstructuredClient` constructor to the target API URL.
102+
104103
The Unstructured Workflow Endpoint enables you to work with [connectors](#connectors),
105104
[workflows](#workflows), and [jobs](#jobs) in the Unstructured UI.
106105

@@ -128,8 +127,11 @@ utilities, tools, programming languages, packages, and libraries. The examples,
128127

129128
<Tip>
130129
You can also use the [Unstructured Workflow Endpoint - Swagger UI](https://platform.unstructuredapp.io/docs) to call the REST endpoints
131-
that are available through `https://platform.unstructuredapp.io`. To use the Swagger UI, you must provide your Unstructured API key with each call. To
130+
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
132131
get this API key, see the [quickstart](#quickstart), earlier on this page.
132+
133+
Note that you should always use the URL that was provided to you when your Unstructured account was created.
134+
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
133135
</Tip>
134136

135137
### curl and Postman
@@ -141,6 +143,14 @@ export UNSTRUCTURED_API_URL="https://platform.unstructuredapp.io/api/v1"
141143
export UNSTRUCTURED_API_KEY="<your-unstructured-api-key>"
142144
```
143145

146+
For the API URL, this URL was provided to you when your Unstructured account was created.
147+
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
148+
149+
<Note>
150+
The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`.
151+
However, you should always use the URL that was provided to you when your Unstructured account was created.
152+
</Note>
153+
144154
These environment variables enable you to more easily run the following `curl` examples and help prevent
145155
you from storing scripts that contain sensitive URLs and API keys in public source code repositories.
146156

@@ -156,8 +166,8 @@ The following Postman examples use variables, which you can set as follows:
156166

157167
- **Variable**: `UNSTRUCTURED_API_URL`
158168
- **Type**: `default`
159-
- **Initial value**: `https://platform.unstructuredapp.io/api/v1`
160-
- **Current value**: `https://platform.unstructuredapp.io/api/v1`
169+
- **Initial value**: The Unstructured Workflow Endpoint URL that was provided to you when your Unstructured account was created.
170+
- **Current value**: The Unstructured Workflow Endpoint URL that was provided to you when your Unstructured account was created.
161171
<br/>
162172
- **Variable**: `UNSTRUCTURED_API_KEY`
163173
- **Type**: `secret`
@@ -225,7 +235,7 @@ The following Unstructured SDKs, tools, and libraries do _not_ work with the Uns
225235
- The [Unstructured Ingest CLI](/open-source/ingestion/ingest-cli)
226236
- The [Unstructured Ingest Python library](/open-source/ingestion/python-ingest)
227237
228-
The following Unstructured API URL is also _not_ supported: `https://api.unstructuredapp.io/general/v0/general` (the Unstructured Partition Endpoint URL).
238+
The following Unstructured API URL is also _not_ supported: `https://api.unstructuredapp.io/general/v0/general` (the default Unstructured Partition Endpoint URL).
229239
230240
## Connectors
231241

open-source/ingestion/ingest-cli.mdx

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,13 @@ Using the Ingest CLI to send files in batches to Unstructured for processing is
2323

2424
<GetStartedSimpleAPIOnly />
2525

26-
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).
27-
You must specify this API URL in your
28-
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.
26+
3. The Unstructured API URL for Unstructured Ingest was provided to you when your Unstructured account was created.
27+
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
2928

30-
<Note>
31-
If the Unstructured API is hosted on your own compute infrastructure, the process
32-
for generating Unstructured API keys, and the Unstructured API URL that you use, are different.
33-
For details, contact Unstructured Sales at
34-
35-
</Note>
29+
<Note>
30+
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`.
31+
However, you should always use the URL that was provided to you when your Unstructured account was created.
32+
</Note>
3633

3734
## Installation
3835

open-source/ingestion/python-ingest.mdx

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,13 @@ Using the Ingest Python library to send files in batches to Unstructured for pro
3535

3636
<GetStartedSimpleAPIOnly />
3737

38-
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).
39-
You must specify this API URL in your
40-
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.
38+
3. The Unstructured API URL for Unstructured Ingest was provided to you when your Unstructured account was created.
39+
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
4140

42-
<Note>
43-
If the Unstructured API is hosted on your own compute infrastructure, the process
44-
for generating Unstructured API keys, and the Unstructured API URL that you use, are different.
45-
For details, contact Unstructured Sales at
46-
47-
</Note>
41+
<Note>
42+
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`.
43+
However, you should always use the URL that was provided to you when your Unstructured account was created.
44+
</Note>
4845

4946
## Installation
5047

snippets/general-shared-text/first-time-api-destination-connector.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
Before you can create a destination connector, you must first sign in to your Unstructured account:
55

66
- 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.
7-
- 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,
8-
or GitHub account that is associated with your Unstructured account.
9-
7+
- 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.
8+
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
9+
1010
After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to get your Unstructured API key.
1111
To learn how, watch this 40-second [how-to video](https://www.youtube.com/watch?v=FucugLkYB6M).
1212

snippets/general-shared-text/first-time-api-source-connector.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
Before you can create a source connector, you must first sign in to your Unstructured account:
55

66
- 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.
7-
- 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,
8-
or GitHub account that is associated with your Unstructured account.
9-
7+
- 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.
8+
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
9+
1010
After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to get your Unstructured API key.
1111
To learn how, watch this 40-second [how-to video](https://www.youtube.com/watch?v=FucugLkYB6M).
1212

snippets/general-shared-text/first-time-ui-destination-connector.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
Before you can create a destination connector, you must first sign in to your Unstructured account:
55

66
- 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.
7-
- 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,
8-
or GitHub account that is associated with your Unstructured account.
9-
7+
- 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.
8+
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
9+
1010
After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to create your destination connector.
1111

1212
After you create the destination connector, add it along with a

snippets/general-shared-text/first-time-ui-source-connector.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
Before you can create a source connector, you must first sign in to your Unstructured account:
55

66
- 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.
7-
- 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,
8-
or GitHub account that is associated with your Unstructured account.
7+
- 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.
8+
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
99

1010
After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to create your source connector.
1111

0 commit comments

Comments
 (0)