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/partition/overview.mdx
+2-63Lines changed: 2 additions & 63 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,70 +12,9 @@ highest-performing models, and for the highest quality results at the lowest cos
12
12
13
13
To call the Unstructured Partition Endpoint, you need an Unstructured account and an Unstructured API key:
14
14
15
-
<Steps>
16
-
<Steptitle="Sign up">
17
-
To sign up for an Unstructured account, go to the [For Developers](https://unstructured.io/developers) page and choose one of the following plans:
18
-
19
-
- Sign up for a [pay-per-page plan](https://unstructured.io/developers#get-started).
20
-
- Save money by signing up for a [subscribe-and-save plan](https://unstructured.io/subscribeandsave) instead.
21
-
22
-
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.
23
-
24
-
<Note>
25
-
If you choose a pay-per-page plan, after your first 14 days of usage or more than 1000 processed pages per day,
26
-
whichever comes first, your account is then billed at Unstructured's standard service usage rates. To keep using the service,
27
-
you must provide Unstructured with your payment details.
28
-
29
-
To save money by switching from a pay-per-page to a subscribe-and-save plan, go to the
30
-
[Unstructured Subscribe & Save](https://unstructured.io/subscribeandsave) page and complete the on-screen instructions.
31
-
32
-
By signing up for a pay-per-page or subscribe-and-save plan, your Unstructured account will run within the context of the Unstructured API on
33
-
Unstructured's own hosted cloud resources. If you would rather run the Unstructured API within the context of your own virtual private cloud (VPC),
34
-
(or you want to save even more money by making a long-term billing commitment),
35
-
stop here and sign up through the [For Enterprise](https://unstructured.io/enterprise) page instead.
36
-
</Note>
37
-
</Step>
38
-
<Steptitle="Sign in">
39
-
<Note>
40
-
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
41
-
plan is activated. Then go to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and click **Login**.
42
-
43
-
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 account sign-in page appears.
48
-
49
-
50
-
51
-
2. Click **Google** or **GitHub** to sign in with the Google or GitHub account that you signed up with.
52
-
Or, enter the email address that you signed up with, and then click **Sign In**.
53
-
3. If you entered your email address, check your email inbox for a message from Unstructured. In that email, click the **Sign In** link.
54
-
4. The first time you sign in, read the terms and conditions, and then click **Accept**.
55
-
56
-
<Tip>
57
-
After you have signed in for the first time, you can
58
-
sign in the second time and beyond by going to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and clicking **Login**.
Copy file name to clipboardExpand all lines: api-reference/partition/sdk-jsts.mdx
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,11 @@ title: JavaScript/TypeScript SDK
5
5
The [Unstructured JavaScript/TypeScript SDK](https://github.com/Unstructured-IO/unstructured-js-client) client allows you to send one file at a time for processing by the Unstructured Partition Endpoint.
6
6
7
7
To use the JavaScript/TypeScript SDK, you'll first need to set an environment variable named `UNSTRUCTURED_API_KEY`,
8
-
representing your Unstructured API key. [Get your API key](/api-reference/partition/overview).
8
+
representing your Unstructured API key. To get your API key, do the following:
Calls made by the Unstructured Python SDK's `unstructured_client` functions for creating, listing, updating,
94
92
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
@@ -148,18 +146,7 @@ you from storing scripts that contain sensitive URLs and API keys in public sour
148
146
149
147
To get your Unstructured API key, do the following:
150
148
151
-
1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io).
152
-
2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.
153
-
3. On the **API Keys** tab, click **Generate New Key**.
154
-
4. Enter some descriptive name for the API key, and then click **Save**.
155
-
5. Click the **Copy** icon for your new API key. The API key's value is copied to your system's clipboard.
156
-
157
-
<Note>
158
-
If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API URL and API key creation guidance
1. Go to [https://platform.unstructured.io](https://platform.unstructured.io) and use your email address, Google account, or GitHub account to
2
+
sign up for an Unstructured account (if you do not already have one) and sign into the account at the same time. The
3
+
[Unstructured user interface (UI)](/ui/overview) appears.
4
+
2. Get your Unstructured API key:
5
+
6
+
a. In the Unstructured UI, click **API Keys** on the sidebar.<br/>
7
+
b. Click **Generate API Key**.<br/>
8
+
c. Follow the on-screen instructions to finish generating the key.<br/>
9
+
d. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.<br/>
10
+
11
+
<Tip>
12
+
By following the preceding instructions, you are signed up for a [Developer](https://unstructured.io/developers) pay per page account by default.
13
+
14
+
To save money, consider switching to a [Subscribe & Save](https://unstructured.io/subscribeandsave) account instead. To save even more money,
15
+
consider switching to an [Enterprise](https://unstructured.io/enterprise) account instead.
1. Go to [https://platform.unstructured.io](https://platform.unstructured.io) and use your email address, Google account, or GitHub account to
2
+
sign up for an Unstructured account (if you do not already have one) and sign into the account at the same time. The
3
+
[Unstructured user interface (UI)](/ui/overview) appears, and you can start using it right away.
4
+
2. If you also want to use the [Unstructured API](/api-reference/overview) later, you must get your API key first:
5
+
6
+
a. In the Unstructured UI, click **API Keys** on the sidebar.<br/>
7
+
b. Click **Generate API Key**.<br/>
8
+
c. Follow the on-screen instructions to finish generating the key.<br/>
9
+
d. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.<br/>
10
+
11
+
<Tip>
12
+
By following the preceding instructions, you are signed up for a [Developer](https://unstructured.io/developers) pay per page account by default.
13
+
14
+
To save money, consider switching to a [Subscribe & Save](https://unstructured.io/subscribeandsave) account instead. To save even more money,
15
+
consider switching to an [Enterprise](https://unstructured.io/enterprise) account instead.
Copy file name to clipboardExpand all lines: snippets/quickstarts/platform-api.mdx
+4-59Lines changed: 4 additions & 59 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,66 +9,11 @@ The requirements are as follows:
9
9
- A compatible destination (output) location for Unstructured to put the processed data. [See the list of supported destination types](/ui/connectors#destinations).
10
10
For this quickstart's destination location, a different folder in the same Amazon S3 bucket as the source location is used. If you use a different destination S3 bucket or a different destination type, you will need to modify the quickstart notebook accordingly.
11
11
12
-
<Steps>
13
-
<Steptitle="Sign up">
14
-
To sign up for Unstructured, go to the [For Developers](https://unstructured.io/developers) page and choose one of the following plans:
15
-
16
-
- Sign up for a [pay-per-page plan](https://unstructured.io/developers#get-started).
17
-
- Save money by signing up for a [subscribe-and-save plan](https://unstructured.io/subscribeandsave) instead.
18
-
19
-
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.
20
-
21
-
<Note>
22
-
If you choose a pay-per-page plan, after your first 14 days of usage or more than 1000 processed pages per day,
23
-
whichever comes first, your account is then billed at Unstructured's standard service usage rates. To keep using the service,
24
-
you must
25
-
[provide Unstructured with your payment details](/ui/billing#add-view-or-change-pay-per-page-payment-details).
26
-
27
-
To save money by switching from a pay-per-page to a subscribe-and-save plan, go to the
28
-
[Unstructured Subscribe & Save](https://unstructured.io/subscribeandsave) page and complete the on-screen instructions.
29
-
To save even more money by making a long-term billing commitment,
30
-
stop here and sign up through the [For Enterprise](https://unstructured.io/enterprise) page instead.
31
-
32
-
By signing up for a pay-per-page or subscribe-and-save plan, your Unstructured account will run within the context of Unstructured on
33
-
Unstructured's own hosted cloud resources. If you would rather run Unstructured within the context of your own virtual private cloud (VPC),
34
-
stop here and sign up through the [For Enterprise](https://unstructured.io/enterprise) page instead.
35
-
</Note>
36
-
</Step>
37
-
<Steptitle="Sign in">
38
-
<Note>
39
-
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
40
-
plan is activated. Then go to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and click **Login**.
41
-
42
-
If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your sign-in process will
49
-
50
-
2. Click **Google** or **GitHub** to sign in with the Google or GitHub account that you signed up with.
51
-
Or, enter the email address that you signed up with, and then click **Sign In**.
52
-
3. If you entered your email address, check your email inbox for a message from Unstructured. In that email, click the **Sign In** link.
53
-
4. The first time you sign in, read the terms and conditions, and then click **Accept**.
54
-
55
-
<Tip>
56
-
After you have signed in for the first time, you can
57
-
sign in the second time and beyond by going to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and clicking **Login**.
0 commit comments