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/api-services/free-api.mdx
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,10 @@ title: Free Unstructured API
3
3
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.
4
4
---
5
5
6
-
<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>
6
+
<Info>
7
+
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)
8
+
or the free 14-day trial for the [Unstructured Platform API](/platform/api/overview).
Copy file name to clipboardExpand all lines: api-reference/api-services/overview.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,4 +70,4 @@ import SharedPagesBilling from '/snippets/general-shared-text/pages-billing.mdx'
70
70
71
71
## Get support
72
72
73
-
Should you require any assistance or have any questions regarding the Unstructured API, please contact our support team at [[email protected]](mailto:support%40unstructured.io).
73
+
Should you require any assistance or have any questions regarding the Unstructured API, please [contact us directly](https://unstructured.io/contact).
Copy file name to clipboardExpand all lines: api-reference/api-services/saas-api-development-guide.mdx
+68-63Lines changed: 68 additions & 63 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,57 +1,92 @@
1
1
---
2
2
title: Unstructured Serverless API
3
-
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.
4
3
---
5
4
5
+
<Note>
6
+
The Unstructured Serverless API is separate from the Unstructured Platform API.
7
+
8
+
For information about the
9
+
Unstructured Platform API, see the [Unstructured Platform API Overview](/platform/api/overview).
10
+
</Note>
11
+
12
+
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.
13
+
6
14
## Get started
7
15
8
-
To call the Unstructured Serverless API, you need an API key and API URL:
16
+
To call the Unstructured Serverless API, you need an Unstructured account, API key, and API URL:
9
17
10
18
<Steps>
11
19
<Steptitle="Sign up">
12
-
Go to the [For Developers](https://unstructured.io/developers) page and enter your information.
20
+
To sign up for an Unstructured account, go to the [For Developers](https://unstructured.io/developers) page and choose one of the following plans:
21
+
22
+
- Sign up for a [pay-per-page plan](https://unstructured.io/developers#get-started).
23
+
- Save money by signing up for a [subscribe-and-save plan](https://unstructured.io/subscribeandsave) instead.
24
+
25
+
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.
13
26
14
27
<Note>
15
-
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
16
-
Unstructured's own hosted cloud resources. Also, after your first 14 days of usage or more than 1000 processed pages per day,
17
-
whichever comes first, your account is then billed at Unstructured's standard service usage rates. You can always
18
-
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,
If you choose a pay-per-page plan, after your first 14 days of usage or more than 1000 processed pages per day,
29
+
whichever comes first, your account is then billed at Unstructured's standard service usage rates. To keep using the service,
30
+
you must provide Unstructured with your payment details.
20
31
21
-
If you would rather run the Unstructured Platform within the context of your own virtual private cloud (VPC),
22
-
or you want to make a long-term billing commitment in exchange for deeply discounted service usage rates,
32
+
To save money by switching from a pay-per-page to a subscribe-and-save plan, go to the
33
+
[Unstructured Subscribe & Save](https://unstructured.io/subscribeandsave) page and complete the on-screen instructions.
34
+
35
+
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
36
+
Unstructured's own hosted cloud resources. If you would rather run the Unstructured Platform within the context of your own virtual private cloud (VPC),
37
+
(or you want to save even more money by making a long-term billing commitment),
23
38
stop here and sign up through the [For Enterprise](https://unstructured.io/enterprise) page instead.
24
39
</Note>
25
40
</Step>
26
41
<Steptitle="Sign in">
27
-

28
-
1. After you have signed up through the [For Developers](https://unstructured.io/developers) page, the Unstructured Platform sign-in page appears.
42
+
<Note>
43
+
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
44
+
plan is activated. Then go to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and click **Login**.
29
45
30
-
<Note>
31
-
If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your sign-in process will
1. After you have signed up for a pay-per-page plan, the Unstructured Platform sign-in page appears.
34
51
35
-
2. Click **Google** or **GitHub** to sign in with the Google or GitHub account that you signed up with through the **For Developers** page.
52
+

53
+
54
+
2. Click **Google** or **GitHub** to sign in with the Google or GitHub account that you signed up with.
36
55
Or, enter the email address that you signed up with, and then click **Sign In**.
37
56
3. If you entered your email address, check your email inbox for a message from Unstructured. In that email, click the **Sign In** link.
38
57
4. The first time you sign in, read the terms and conditions, and then click **Accept**.
39
58
40
59
<Tip>
41
-
After you have signed in through the [For Developers](https://unstructured.io/developers) page for the first time, you can
60
+
After you have signed in for the first time, you can
42
61
sign in the second time and beyond by going to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and clicking **Login**.

51
-
1. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.
52
-
2. On the account settings sidebar, click **API Keys**, if it is not already selected.
53
-
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.
54
-
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.
70
+

71
+
72
+
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**.
73
+
2. On the **API Keys** tab, click **Generate New Key**.
74
+
3. Enter some descriptive name for the API key, and then click **Save**.
75
+
4. Click the **Copy** icon for your new API key. The API key's value is copied to your system's clipboard.
76
+
5. Note the Unstructured **Serverless API URL**, which is `https://api.unstructuredapp.io/general/v0/general`
77
+
78
+

79
+
80
+
<Warning>
81
+
Do not use the Unstructured **Platform API URL**, which is separate from the Unstructured Serverless API URL.
82
+
</Warning>
83
+
84
+
<Note>
85
+
If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API URL
If your API URL is different, be sure to substitute `https://api.unstructuredapp.io/general/v0/general` for your
88
+
API URL throughout the following examples.
89
+
</Note>
55
90
</Step>
56
91
</Steps>
57
92
@@ -63,11 +98,11 @@ import ServerlessKeyNoFreeURL from '/snippets/general-shared-text/serverless-api
63
98
64
99
## Set up billing
65
100
66
-
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.
101
+
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.
67
102
68
103
<Note>
69
-
If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your billing setup and terms will
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
2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.
84
-
3.On the account settings sidebar, click **Billing**.
85
-
4. Click **Manage Payment Method**, follow the on-screen instructions to enter your payment details through Stripe, and then click **Save card**.
119
+
3.Click the **Billing** tab.
120
+
4. Click **Manage Payment Method**, follow the on-screen instructions to enter or update your payment details, and then click **Save card**.
86
121
87
122
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.
88
123
89
-
<Note>
90
-
You can always
91
-
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,
0 commit comments