diff --git a/api-reference/legacy-api/free-api.mdx b/api-reference/legacy-api/free-api.mdx deleted file mode 100644 index 91a2ed6b..00000000 --- a/api-reference/legacy-api/free-api.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: Free Unstructured API ---- - - - 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 API](/api-reference/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. - - -This page describes how to obtain an API key to use with the free Unstructured API, the limitations of the free Unstructured API, and provides a quickstart example. - -## Get an API key - -The Free Unstructured API requires authentication via an API key. Here's how you can obtain your API key: - -1. Go to [https://unstructured.io/api-key-free](https://unstructured.io/api-key-free). -2. Fill out the registration form. Make sure your contact information (especially your **Email**) is valid. -3. Check the **I agree** box if you consent to Unstructured contacting you about our products and services. -4. Click the **Terms and Conditions** link, read it, and check the related box to agree. -5. Click **Submit**. You will receive a Free Unstructured API key at the **Email** you provided. Store your API key in a secure location. Do not share it with others. -6. For the Free Unstructured API, the API URL is `https://api.unstructured.io/general/v0/general` - -[Try the quickstart](#quickstart). - -## Free Unstructured API limitations - -The Free Unstructured API is designed for prototyping purposes, and not for production use: -* The API usage is limited to 1000 pages per month. -* 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 API](/api-reference/overview) instead. - -import SharedPagesBilling from '/snippets/general-shared-text/pages-billing.mdx'; - - - -## Quickstart - -These examples use your local machine. They send source (input) files from your local machine to Unstructured which delivers the processed data to a destination (output) location, also on your local machine. Data is processed on Unstructured-hosted compute resources. - -### Unstructured Ingest CLI - -To work with the Free Unstructured API by using the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli), you will need to: - -- Install Python, and then install the CLI package: - - ```bash - pip install unstructured - ``` - -- 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](/api-reference/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: - -- `` with the source (input) path to the directory on your local machine that contains the compatible files for Unstructured to process on its hosted compute resources. -- `` with the destination (output) path to the directory on your local machine that will contain the processed data that Unstructured returns from its hosted compute resources. - -```bash CLI -unstructured-ingest \ - local \ - --input-path \ - --output-dir \ - --partition-by-api \ - --api-key $UNSTRUCTURED_API_KEY \ - --partition-endpoint $UNSTRUCTURED_API_URL \ - --strategy hi_res \ - --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}" -``` - -After the command successfully runs, see the results in the specified output path on your local machine. - -### Unstructured Ingest Python library - -To work with Unstructured by using the [Unstructured Python library](/ingestion/python-ingest), you will need to: - -- Install Python, and then install the CLI package: - - ```bash - pip install unstructured-ingest - ``` - -- Set the following environment variables: - - - Set `UNSTRUCTURED_API_KEY` to your API key. - - Set `UNSTRUCTURED_API_URL` to your API URL. - - [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](/api-reference/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: - -- `` with the source (input) path to the directory on your local machine that contains the compatible files for Unstructured to process on its hosted compute resources. -- `` with the destination (output) path to the directory on your local machine that will contain the processed data that Unstructured returns from its hosted compute resources. - -import LocalToLocalPythonIngestLibrary from '/snippets/ingestion/local-to-local.v2.py.mdx'; - - - -After the command successfully runs, see the results in the specified output path on your local machine. - -## Telemetry - -import SharedTelemetry from '/snippets/general-shared-text/telemetry.mdx'; - - - - - diff --git a/api-reference/legacy-api/overview.mdx b/api-reference/legacy-api/overview.mdx index 772fe648..46b6bcf2 100644 --- a/api-reference/legacy-api/overview.mdx +++ b/api-reference/legacy-api/overview.mdx @@ -4,10 +4,6 @@ title: Overview Unstructured has deprecated the following APIs: -- The [Free Unstructured API](/api-reference/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 API](/api-reference/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](/api-reference/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 diff --git a/docs.json b/docs.json index 56b3402a..f9f64357 100644 --- a/docs.json +++ b/docs.json @@ -223,7 +223,6 @@ "group": "Legacy APIs", "pages": [ "api-reference/legacy-api/overview", - "api-reference/legacy-api/free-api", "api-reference/legacy-api/aws", "api-reference/legacy-api/azure" ] @@ -660,6 +659,10 @@ "source": "/api-reference/ingest/:slug*", "destination": "/ingestion/:slug*" }, + { + "source": "/api-reference/legacy/free-api", + "destination": "/api-reference/overview" + }, { "source": "/api-reference/troubleshooting/api-key-url", "destination": "/api-reference/troubleshooting/api-key-url"