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
5 changes: 4 additions & 1 deletion api-reference/api-services/free-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ title: Free Unstructured API
description: 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.
---

<Info>The Free Unstructured API is different than the free 14-day trial for the [Unstructured Serverless API](/api-reference/api-services/saas-api-development-guide).</Info>
<Info>
The Free Unstructured API is different than the free 14-day trial for the [Unstructured Serverless API](/api-reference/api-services/saas-api-development-guide)
or the free 14-day trial for the [Unstructured Platform API](/platform/api/overview).
</Info>

## Get an API key

Expand Down
2 changes: 1 addition & 1 deletion api-reference/api-services/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ import SharedPagesBilling from '/snippets/general-shared-text/pages-billing.mdx'

## Get support

Should you require any assistance or have any questions regarding the Unstructured API, please contact our support team at [support@unstructured.io](mailto:support%40unstructured.io).
Should you require any assistance or have any questions regarding the Unstructured API, please [contact us directly](https://unstructured.io/contact).
131 changes: 68 additions & 63 deletions api-reference/api-services/saas-api-development-guide.mdx
Original file line number Diff line number Diff line change
@@ -1,57 +1,92 @@
---
title: Unstructured Serverless API
description: This page describes how to get started with the Unstructured Serverless API. Learn how to obtain an API key to use with the Unstructured Serverless API, and get started in no time.
---

<Note>
The Unstructured Serverless API is separate from the Unstructured Platform API.

For information about the
Unstructured Platform API, see the [Unstructured Platform API Overview](/platform/api/overview).
</Note>

This page describes how to get started with the Unstructured Serverless API. Learn how to obtain an API key to use with the Unstructured Serverless API, and get started in no time.

## Get started

To call the Unstructured Serverless API, you need an API key and API URL:
To call the Unstructured Serverless API, you need an Unstructured account, API key, and API URL:

<Steps>
<Step title="Sign up">
Go to the [For Developers](https://unstructured.io/developers) page and enter your information.
To sign up for an Unstructured account, go to the [For Developers](https://unstructured.io/developers) page and choose one of the following plans:

- Sign up for a [pay-per-page plan](https://unstructured.io/developers#get-started).
- Save money by signing up for a [subscribe-and-save plan](https://unstructured.io/subscribeandsave) instead.

If you're not sure which plan to sign up for, start with a [pay-per-page plan](https://unstructured.io/developers#get-started). You can always switch plans later.

<Note>
By signing up through the [For Developers](https://unstructured.io/developers) page, your Unstructured account will run within the context of the Unstructured Platform on
Unstructured's own hosted cloud resources. Also, after your first 14 days of usage or more than 1000 processed pages per day,
whichever comes first, your account is then billed at Unstructured's standard service usage rates. You can always
start a prepaid subscription in exchange for usage rate discounts. To switch your account from a pay-as-you-go plan to a prepaid subscription,
contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
If you choose a pay-per-page plan, after your first 14 days of usage or more than 1000 processed pages per day,
whichever comes first, your account is then billed at Unstructured's standard service usage rates. To keep using the service,
you must provide Unstructured with your payment details.

If you would rather run the Unstructured Platform within the context of your own virtual private cloud (VPC),
or you want to make a long-term billing commitment in exchange for deeply discounted service usage rates,
To save money by switching from a pay-per-page to a subscribe-and-save plan, go to the
[Unstructured Subscribe & Save](https://unstructured.io/subscribeandsave) page and complete the on-screen instructions.

By signing up for a pay-per-page or subscribe-and-save plan, your Unstructured account will run within the context of the Unstructured Platform on
Unstructured's own hosted cloud resources. If you would rather run the Unstructured Platform within the context of your own virtual private cloud (VPC),
(or you want to save even more money by making a long-term billing commitment),
stop here and sign up through the [For Enterprise](https://unstructured.io/enterprise) page instead.
</Note>
</Step>
<Step title="Sign in">
![Sign in to your Unstructured account](/img/platform/Signin.png)
1. After you have signed up through the [For Developers](https://unstructured.io/developers) page, the Unstructured Platform sign-in page appears.
<Note>
If you initially signed up for a subscribe-and-save plan instead of a pay-per-page plan, wait to complete this step until after you receive confirmation from Unstructured that your
plan is activated. Then go to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and click **Login**.

<Note>
If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your sign-in process will
be different. For enterprise sign-in guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
</Note>
If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your sign-in process will
be different. For enterprise sign-in guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
</Note>

1. After you have signed up for a pay-per-page plan, the Unstructured Platform sign-in page appears.

2. Click **Google** or **GitHub** to sign in with the Google or GitHub account that you signed up with through the **For Developers** page.
![Sign in to your Unstructured account](/img/platform/Signin.png)

2. Click **Google** or **GitHub** to sign in with the Google or GitHub account that you signed up with.
Or, enter the email address that you signed up with, and then click **Sign In**.
3. If you entered your email address, check your email inbox for a message from Unstructured. In that email, click the **Sign In** link.
4. The first time you sign in, read the terms and conditions, and then click **Accept**.

<Tip>
After you have signed in through the [For Developers](https://unstructured.io/developers) page for the first time, you can
After you have signed in for the first time, you can
sign in the second time and beyond by going to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and clicking **Login**.

For enterprise sign-in guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
</Tip>

</Step>
<Step title="Get your API key and API URL">
![Unstructured account settings](/img/platform/AccountSettings.png)

![Unstructured API key and API URL](/img/platform/APIKeyURL.png)
1. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.
2. On the account settings sidebar, click **API Keys**, if it is not already selected.
3. To get your API key, click the copy icon in the **Actions** column for your API key, and then click **Key Only**. Store your copied API key in a secure location. Do not share it with others.
4. To get your API URL, click the copy icon next to the URL next to **API URL**. Store your copied API URL in a secure location. Do not share it with others.
![Unstructured API key and API URL](/img/platform/APIKeyOnly.png)

1. After you have signed in to your Unstructured account, at the bottom of the sidebar, click your user icon, and then click **Account Settings**.
2. On the **API Keys** tab, click **Generate New Key**.
3. Enter some descriptive name for the API key, and then click **Save**.
4. Click the **Copy** icon for your new API key. The API key's value is copied to your system's clipboard.
5. Note the Unstructured **Serverless API URL**, which is `https://api.unstructuredapp.io/general/v0/general`

![Unstructured Serverless API URL](/img/platform/ServerlessAPIURL.png)

<Warning>
Do not use the Unstructured **Platform API URL**, which is separate from the Unstructured Serverless API URL.
</Warning>

<Note>
If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API URL
might be different. For API URL guidance, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
If your API URL is different, be sure to substitute `https://api.unstructuredapp.io/general/v0/general` for your
API URL throughout the following examples.
</Note>
</Step>
</Steps>

Expand All @@ -63,11 +98,11 @@ import ServerlessKeyNoFreeURL from '/snippets/general-shared-text/serverless-api

## Set up billing

Once you sign up for the Unstructured Serverless API through the [For Developers](https://unstructured.io/developers) page, you can enjoy a free 14-day trial with usage capped at 1000 pages per day.
If you signed up for a pay-per-page plan, you can enjoy a free 14-day trial with usage capped at 1000 pages per day.

<Note>
If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your billing setup and terms will
be different. For enterprise billing guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
If you initially signed up for a subscribe-and-save plan instead, of if you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your billing setup and terms will
be different. For billing guidance, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).

The free 14-day trial for the Unstructured Serverless API is different than the [Free Unstructured API](/api-reference/api-services/free-api).
</Note>
Expand All @@ -77,20 +112,19 @@ the Unstructured Serverless API:

![Unstructured account settings](/img/platform/AccountSettings.png)

![Unstructured account billing](/img/platform/AccountBilling.png)
![Unstructured account payment method](/img/platform/AccountBillingPaymentMethod.png)

1. Sign in to the Unstructured Platform.
2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.
3. On the account settings sidebar, click **Billing**.
4. Click **Manage Payment Method**, follow the on-screen instructions to enter your payment details through Stripe, and then click **Save card**.
3. Click the **Billing** tab.
4. Click **Manage Payment Method**, follow the on-screen instructions to enter or update your payment details, and then click **Save card**.

Your card is billed monthly based on your usage. The **Billing** page shows a billing overview for the current month and a list of your billing invoices.

<Note>
You can always
start a prepaid subscription in exchange for usage rate discounts. To switch your account from a pay-as-you-go plan to a prepaid subscription,
contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
</Note>
<Tip>
You can save money by switching from a pay-per-page plan to a subscribe-and-save plan. To do this,
go to the [Unstructured Subscribe & Save](https://unstructured.io/subscribeandsave) page and complete the on-screen instructions.
</Tip>

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

Expand Down Expand Up @@ -168,35 +202,6 @@ import LocalToLocalPythonIngestLibrary from '/snippets/ingestion/local-to-local.

After the command successfully runs, see the results in the specified output path on your local machine.

## Manage your account

**To manage your account**:

![Unstructured account settings](/img/platform/AccountSettings.png)

1. Sign in to the Unstructured Platform.
2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.

![Unstructured account settings sidebar](/img/platform/AccountSettingsSidebar.png)

**To manage your API keys**:

* On the account settings sidebar, click **API Keys**.
* To create a key, click **Generate New Key**, and follow the on-screen instructions.
* To enable or disable a key, switch **On/Off** in the column for that key to on or off.
* To delete a key, click the trash can in the **Actions** column for that key.

**To view your usage**: On the account settings sidebar, click **Usage**.

**To view your billing costs and invoices and to manage your payment method**: On the account settings sidebar, click **Billing**.

**To log out of your account**: On the account settings sidebar, click your email address, and then click **Logout**.

**To get help**: Our support team is just a text or email away:

* On the account settings sidebar, click **Message Us**, or...
* Email us at [support@unstructured.io](mailto:support@unstructured.io).

## Telemetry

import SharedTelemetry from '/snippets/general-shared-text/telemetry.mdx';
Expand Down
Loading