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/examples.mdx
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,14 @@ description: This page provides some examples of accessing Unstructured Partitio
6
6
To use these examples, you'll first need to set an environment variable named `UNSTRUCTURED_API_KEY`,
7
7
representing your Unstructured API key. [Get your API key](/api-reference/partition/overview).
8
8
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.
Copy file name to clipboardExpand all lines: api-reference/partition/overview.mdx
+8-1Lines changed: 8 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,14 @@ available for download from [https://constitutioncenter.org/media/files/constitu
35
35
<Steptitle="Set environment variables">
36
36
From your terminal or Command Prompt, set the following two environment variables.
37
37
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.
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>
33
39
34
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
+15-12Lines changed: 15 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,25 +35,24 @@ API error occurred: Status 404
35
35
36
36
## Suggested solutions
37
37
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.
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
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.
48
47
</Note>
49
48
50
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:
51
50
52
51
1. Sign in to your Unstructured account:
53
52
54
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.
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.
@@ -73,8 +72,12 @@ For the API key, the same API key works for both the [Unstructured Workflow Endp
73
72
74
73
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:
75
74
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.
2. In the Unstructured UI, click **API Keys** on the sidebar.
79
82
3. Note the API URL for the **Unstructured Workflow Endpoint** or the **Unstructured Partition Endpoint**, depending on whether you want to call the
80
83
[Unstructured Workflow Endpoint](/api-reference/workflow/overview) or the [Unstructured Partition Endpoint](/api-reference/partition/overview), respectively.
Copy file name to clipboardExpand all lines: api-reference/workflow/overview.mdx
+22-12Lines changed: 22 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -89,18 +89,17 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s
89
89
<GetStartedSimpleAPIOnly/>
90
90
91
91
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.
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.
102
99
</Note>
103
100
101
+
To specify an API URL in your code, set the `server_url` parameter in the `UnstructuredClient` constructor to the target API URL.
102
+
104
103
The Unstructured Workflow Endpoint enables you to work with [connectors](#connectors),
105
104
[workflows](#workflows), and [jobs](#jobs) in the Unstructured UI.
106
105
@@ -128,8 +127,11 @@ utilities, tools, programming languages, packages, and libraries. The examples,
128
127
129
128
<Tip>
130
129
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
132
131
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.
-**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.
161
171
<br/>
162
172
-**Variable**: `UNSTRUCTURED_API_KEY`
163
173
-**Type**: `secret`
@@ -225,7 +235,7 @@ The following Unstructured SDKs, tools, and libraries do _not_ work with the Uns
225
235
- The [Unstructured Ingest CLI](/open-source/ingestion/ingest-cli)
226
236
- The [Unstructured Ingest Python library](/open-source/ingestion/python-ingest)
227
237
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).
Copy file name to clipboardExpand all lines: open-source/ingestion/ingest-cli.mdx
+6-9Lines changed: 6 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,16 +23,13 @@ Using the Ingest CLI to send files in batches to Unstructured for processing is
23
23
24
24
<GetStartedSimpleAPIOnly />
25
25
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.
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.
Copy file name to clipboardExpand all lines: open-source/ingestion/python-ingest.mdx
+6-9Lines changed: 6 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,16 +35,13 @@ Using the Ingest Python library to send files in batches to Unstructured for pro
35
35
36
36
<GetStartedSimpleAPIOnly />
37
37
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.
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.
Copy file name to clipboardExpand all lines: snippets/general-shared-text/first-time-api-destination-connector.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
@@ -4,9 +4,9 @@
4
4
Before you can create a destination connector, you must first sign in to your Unstructured account:
5
5
6
6
- 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.
Copy file name to clipboardExpand all lines: snippets/general-shared-text/first-time-api-source-connector.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
@@ -4,9 +4,9 @@
4
4
Before you can create a source connector, you must first sign in to your Unstructured account:
5
5
6
6
- 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.
Copy file name to clipboardExpand all lines: snippets/general-shared-text/first-time-ui-destination-connector.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
@@ -4,9 +4,9 @@
4
4
Before you can create a destination connector, you must first sign in to your Unstructured account:
5
5
6
6
- 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.
0 commit comments