SaaS API Deployment Guide

This documentation serves as a guide for Unstructured SaaS API users to register, receive an API key and URL, and manage your account and billing information. It contains all the necessary instructions and resources to facilitate a smooth setup and deployment process of Hosted API on Unstructured infrastructure.

New User Sign-up

Navigate to the Unstructured SaaS API page on our website.
Fill out the registration form with your details:
- First Name: Enter your given name.
- Last Name: Enter your family or surname.
- Email: Provide a valid email address where we can send you confirmations and communications.
- Company: Enter the name of your company or organization.
Optional Preferences:
- Check the box to sign up for future marketing emails and product updates.
- Check the box to sign up for weekly usage usage emails.
Terms and Conditions:
- Read and accept our terms and conditions by checking the appropriate box to proceed.
Click the “Sign Up” button to create your account.

Email Confirmation and Payment Processing

Upon successful sign-up, you will receive an email from Stripe.
- There will be a small initiation fee for all new subscriptions. This one-time fee will be charged to your credit card to enable automatic billing.
Click the “Pay this invoice” button in the email and follow the instructions to enter your payment details securely on Stripe website.
Confirm the payment to complete this process. Look out for any confirmation prompts or messages that signify a successful transaction.
- Note that we don’t send out a receipt. If you want to keep a receipt, click the “Download invoice” button after completing the payment on Stripe.

Using the API Key and URL

After your payment is processed, you will receive an email from Unstructured containing your unique API KEY and URL.
Check your inbox (and the spam folder, just in case) for an email from our domain.
Save these credentials securely, as you will need them to access and integrate our API with your applications.

Example: Parsing a Document via SaaS API

Please refer to the sample code and output provided below to begin processing documents with your SaaS API.

Warning

When using the Command Line Interface (CLI), ensure that you copy the complete SaaS API URL provided in your email. This URL should include the specific path /general/v0/general.

# Make sure to replace the placeholders with the actual URL and API key from your email
# Include the path `/general/v0/general` in the URL.

curl -X 'POST' 'https://<REPLACE WITH THE URL IN THE EMAIL>'
     -H 'accept: application/json'
     -H 'Content-Type: multipart/form-data'
     -H 'unstructured-api-key: <REPLACE WITH API KEY IN THE EMAIL>'
     -F 'files=@sample-docs/family-day.eml'

Or, you can use partition_via_api to access the SaaS API URL.

from unstructured.partition.api import partition_via_api

filename = "example-docs/eml/fake-email.eml"

elements = partition_via_api(
  filename=filename,
  api_key=<<REPLACE WITH YOUR API KEY>>,
  api_url="https://<<REPLACE WITH YOUR SERVER URL>>/general/v0/general"
)

Warning

When using the Unstructured Python SDK or JavaScript SDK, it is important to omit the path /general/v0/general from the server_url parameter. Additionally, ensure you use https in the URL to prevent potential errors.

from unstructured_client import UnstructuredClient

# Remember NOT to include `/general/v0/general` in the `server_url`
s = UnstructuredClient(api_key_auth="<YOUR_API_KEY>",  # Replace <YOUR_API_KEY> with the API key provided in the email
                       server_url="<YOUR_SERVER_URL>") # Replace <YOUR_SERVER_URL> with the server URL provided in the email

SaaS API Account Maintenance

Opt-in to Usage Emails

To receive regular updates on usage statistics, please follow these steps:

From the Unstructured SaaS API webpage, navigate to FAQ section and click the “Subscribe to Usage Updates” link.
Enter your email address in the provided field.
Click the “Submit” button to complete the subscription process.

You will start receiving the weekly usage email after your submit the form. To opt-out from the email subscription, please contact our Support team at support@unstructured.io.

Update Payment Method

If you need to update your billing information, fill out the “Update Billing” form.

From the Unstructured SaaS API webpage, navigate to FAQ section and click the “Update Payment Method” link.
Enter your email address in the provided field.
Click the “Submit” button to complete the subscription process.

Upon successful form submission, you will be redirected to the Stripe payment page. Follow the instructions to enter your payment details securely. Confirm the payment to complete this process.

Please note that there will be a nominal fee charged to your credit card to verify the payment method. Stripe will refund this fee once the new payment method is confirmed. You will receive a confirmation email about the refund. We will use this new payment method for your next invoices.

Cancel Plan

To cancel your current plan, please complete the following steps:

From the Unstructured SaaS API webpage, navigate to FAQ section and click the “Cancel Plan” link.
When the pop-up form appears, provide your registered Email in the first field.
Enter your Current API Key in the following field.
Click the Submit button to send your cancellation request.

Upon submission, our team will process your request, and you will receive a confirmation email regarding the cancellation of your plan.

Note

Please contact our Support team at support@unstructured.io, if you need to re-register Unstructured SaaS API using the same email address after you cancel your plan.

Rotate a New API Key

If you need to rotate your API key for security reasons or API key regeneration, follow these steps:

From the Unstructured SaaS API webpage, navigate to FAQ section and click the “Get a new API Key” link.
Type your registered Email address in the corresponding input field.
Provide your Current API Key in the specified field.
Press the Submit button to initiate the API key rotation process.

Once you submit the form, our system automatically generates a new API key and deactivates the old one. You will receive the new API key at your registered email address. Be sure to update your applications with the new API key to maintain access to the API services.

Get Support

Navigate to FAQ section on Unstructured SaaS API webpage.
For any other assistance or queries, please get in touch with our Support team at support@unstructured.io.