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
2 changes: 1 addition & 1 deletion platform-api/legacy-api/aws.mdx → api/legacy-api/aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ For example, run one of the following, setting the following environment variabl
- Set `UNSTRUCTURED_API_URL` to `http://`, followed by your load balancer's DNS name, followed by `/general/v0/general`.

<Info>You can now use this value (`http://`, followed by your load balancer's DNS name, followed by `/general/v0/general`) in place of
calling the [Unstructured Platform Partition Endpoint](/platform-api/partition-api/overview) URL as described elsewhere in the Unstructured API documentation.</Info>
calling the [Unstructured Partition Endpoint](/api/partition/overview) URL as described elsewhere in the Unstructured API documentation.</Info>

- Set `LOCAL_FILE_INPUT_DIR` to the path on your local machine to the files for the Unstructured API to process. If you do not have any input files available, you can download any of the ones from the [example-docs](https://github.com/Unstructured-IO/unstructured-ingest/tree/main/example-docs) folder in GitHub.
- Set `LOCAL_FILE_OUTPUT_DIR` to the path on your local machine for Unstructured API to send the processed output in JSON format:
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Free Unstructured API
<Warning>
The Free Unstructured API is in the process of deprecation by April 4, 2025. It is no longer supported and is not being actively updated.

Unstructured recommends that you use the [Unstructured Platform API](/platform-api/overview) instead, which provides new users with 14 days of free usage at up to 1000 pages per day during that period.
Unstructured recommends that you use the [Unstructured API](/api/overview) instead, which provides new users with 14 days of free usage at up to 1000 pages per day during that period.

This page is not being actively updated. It might contain out-of-date information. This page is provided for legacy reference purposes only.
</Warning>
Expand All @@ -32,7 +32,7 @@ The Free Unstructured API is designed for prototyping purposes, and not for prod
* Users of the Free Unstructured API do not get their own dedicated infrastructure.
* The data sent over the Free Unstructured API can be used for model training purposes, and other service improvements.

If you require a production-ready API, consider using the [Unstructured Platform API](/platform-api/overview) instead.
If you require a production-ready API, consider using the [Unstructured API](/api/overview) instead.

import SharedPagesBilling from '/snippets/general-shared-text/pages-billing.mdx';

Expand All @@ -55,7 +55,7 @@ To work with the Free Unstructured API by using the [Unstructured Ingest CLI](/i
- Set the `UNSTRUCTURED_API_KEY` environment variable to your Free Unstructured API key.
- Set the `UNSTRUCTURED_API_URL` environment variable to your Free Unstructured API URL, which is `https://api.unstructured.io/general/v0/general`

- Have some compatible files on your local machine to be processed. [See the list of supported file types](/platform-api/supported-file-types). If you do not have any files available, you can download some from the [example-docs](https://github.com/Unstructured-IO/unstructured-ingest/tree/main/example-docs) folder in the Unstructured repo on GitHub.
- Have some compatible files on your local machine to be processed. [See the list of supported file types](/api/supported-file-types). If you do not have any files available, you can download some from the [example-docs](https://github.com/Unstructured-IO/unstructured-ingest/tree/main/example-docs) folder in the Unstructured repo on GitHub.

Now, use the CLI to call the API, replacing:

Expand Down Expand Up @@ -93,7 +93,7 @@ To work with Unstructured by using the [Unstructured Python library](/ingestion/

[Get your API key and API URL](#get-started).

- Have some compatible files on your local machine to be processed. [See the list of supported file types](/platform-api/supported-file-types). If you do not have any files available, you can download some from the [example-docs](https://github.com/Unstructured-IO/unstructured-ingest/tree/main/example-docs) folder in the Unstructured repo on GitHub. If you do not have any files available, you can download some from the [example-docs](https://github.com/Unstructured-IO/unstructured-ingest/tree/main/example-docs) folder in the Unstructured repo on GitHub.
- Have some compatible files on your local machine to be processed. [See the list of supported file types](/api/supported-file-types). If you do not have any files available, you can download some from the [example-docs](https://github.com/Unstructured-IO/unstructured-ingest/tree/main/example-docs) folder in the Unstructured repo on GitHub. If you do not have any files available, you can download some from the [example-docs](https://github.com/Unstructured-IO/unstructured-ingest/tree/main/example-docs) folder in the Unstructured repo on GitHub.

Now, use the CLI to call the API, replacing:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ title: Overview

Unstructured has deprecated the following APIs:

- The [Free Unstructured API](/platform-api/legacy-api/free-api) is in the process of deprecation by April 4, 2025.
- The [Free Unstructured API](/api/legacy-api/free-api) is in the process of deprecation by April 4, 2025.
It is no longer supported and is not being actively updated. Unstructured recommends that you use the
[Unstructured Platform API](/platform-api/overview) instead, which provides new users with 14 days of free usage at up to
[Unstructured API](/api/overview) instead, which provides new users with 14 days of free usage at up to
1000 pages per day during that period.
- The [Unstructured API on AWS](/platform-api/legacy-api/aws) is deprecated. It is no longer supported and is not being actively updated.
- The [Unstructured API on AWS](/api/legacy-api/aws) is deprecated. It is no longer supported and is not being actively updated.
Unstructured is now available on the AWS Marketplace as a private offering. To explore supported options
for running Unstructured within your virtual private cloud (VPC), email Unstructured Sales at
[sales@unstructured.io](mailto:sales@unstructured.io).
- The [Unstructured API on Azure](/platform-api/legacy-api/azure) is deprecated. It is no longer supported and is not being actively updated.
- The [Unstructured API on Azure](/api/legacy-api/azure) is deprecated. It is no longer supported and is not being actively updated.
Unstructured is now available on the AWS Marketplace as a private offering. To explore supported options
for running Unstructured within your virtual private cloud (VPC), email Unstructured Sales at
[sales@unstructured.io](mailto:sales@unstructured.io).
Expand Down
16 changes: 8 additions & 8 deletions platform-api/overview.mdx → api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
title: Overview
---

The Unstructured Platform API consists of two parts:
The Unstructured API consists of two parts:

- The [Unstructured Platform Workflow Endpoint](/platform-api/api/overview) enables a full range of partitioning, chunking, embedding, and
- The [Unstructured Workflow Endpoint](/api/workflow/overview) enables a full range of partitioning, chunking, embedding, and
enrichment options for your files and data. It is designed to batch-process files and data in remote locations; send processed results to
various storage, databases, and vector stores; and use the latest and highest-performing models on the market today. It has built-in logic
to deliver the highest quality results at the lowest cost. [Learn more](/platform-api/api/overview).
- The [Unstructured Platform Partition Endpoint](/platform-api/partition-api/overview) is intended for rapid prototyping of Unstructured's
to deliver the highest quality results at the lowest cost. [Learn more](/api/workflow/overview).
- The [Unstructured Partition Endpoint](/api/partition/overview) is intended for rapid prototyping of Unstructured's
various partitioning strategies, with limited support for chunking. It is designed to work only with processing of local files, one file
at a time. Use the [Unstructured Platform Workflow Endpoint](/platform-api/api/overview) for production-level scenarios, file processing in
at a time. Use the [Unstructured Workflow Endpoint](/api/workflow/overview) for production-level scenarios, file processing in
batches, files and data in remote locations, generating embeddings, applying post-transform enrichments, using the latest and
highest-performing models, and for the highest quality results at the lowest cost. [Learn more](/platform-api/partition-api/overview).
highest-performing models, and for the highest quality results at the lowest cost. [Learn more](/api/partition/overview).

# Benefits over open source

The Unstructured Platform API provides the following benefits beyond the [Unstructured open source library](/open-source/introduction/overview) offering:
The Unstructured API provides the following benefits beyond the [Unstructured open source library](/open-source/introduction/overview) offering:

* Designed for production scenarios.
* Significantly increased performance on document and table extraction.
Expand All @@ -33,4 +33,4 @@ The Unstructured Platform API provides the following benefits beyond the [Unstru

## Get support

Should you require any assistance or have any questions regarding the Unstructured Platform API, please [contact us directly](https://unstructured.io/contact).
Should you require any assistance or have any questions regarding the Unstructured API, please [contact us directly](https://unstructured.io/contact).
Loading