Skip to content
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
13 changes: 8 additions & 5 deletions api-reference/partition/examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]](mailto:[email protected]).

<Note>
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.
</Note>

### Changing partition strategy for a PDF

Expand Down
9 changes: 8 additions & 1 deletion api-reference/partition/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,14 @@ available for download from [https://constitutioncenter.org/media/files/constitu
<Step title="Set environment variables">
From your terminal or Command Prompt, set the following two environment variables.

- Replace `<your-unstructured-api-url>` with the Unstructured Partition Endpoint URL, which is `https://api.unstructuredapp.io/general/v0/general`
- 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 [[email protected]](mailto:[email protected]).

<Note>
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.
</Note>

- Replace `<your-unstructured-api-key>` with your Unstructured API key, which you generated earlier on this page.

```bash
Expand Down
8 changes: 7 additions & 1 deletion api-reference/partition/post-requests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,13 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s

<GetStartedSimpleAPIOnly/>

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

<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.
</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
27 changes: 15 additions & 12 deletions api-reference/troubleshooting/api-key-url.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,25 +35,24 @@ 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 [[email protected]](mailto:[email protected]).

<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]).
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.
</Note>

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:

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

2. Get your Unstructured API key:

Expand All @@ -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 [[email protected]](mailto:[email protected]).

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.
Expand Down
34 changes: 22 additions & 12 deletions api-reference/workflow/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,18 +89,17 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s
<GetStartedSimpleAPIOnly/>

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

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

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.

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

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

### curl and Postman
Expand All @@ -141,6 +143,14 @@ export UNSTRUCTURED_API_URL="https://platform.unstructuredapp.io/api/v1"
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 [[email protected]](mailto:[email protected]).

<Note>
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.
</Note>

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.

Expand All @@ -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.
<br/>
- **Variable**: `UNSTRUCTURED_API_KEY`
- **Type**: `secret`
Expand Down Expand Up @@ -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

Expand Down
15 changes: 6 additions & 9 deletions open-source/ingestion/ingest-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,13 @@ Using the Ingest CLI to send files in batches to Unstructured for processing is

<GetStartedSimpleAPIOnly />

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

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

## Installation

Expand Down
15 changes: 6 additions & 9 deletions open-source/ingestion/python-ingest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,13 @@ Using the Ingest Python library to send files in batches to Unstructured for pro

<GetStartedSimpleAPIOnly />

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

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

## Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]](mailto:[email protected]).

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).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]](mailto:[email protected]).

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).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]](mailto:[email protected]).

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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]](mailto:[email protected]).

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

Expand Down
Loading