Unstructured API Account

Overview

You can use this account type to connect Unstructured Snaps with data sources that use the Unstructured API Account.

Unstructured API Settings

Prerequisites

Valid Unstructured API Account credentials.

Limitations and known issues

None.

Account settings

Legend:
  • Expression icon (): Allows using JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / Field set Type Description
Label String

Required. Specify a unique label for the account.

Default value: N/A

Example: Unstructured API Account
Hostname String/Expression

Required. Specify the hostname to connect to the Unstructured API endpoint.

Default value: https://api.unstructured.io

Example:
  • https://api.unstructured.io - to access the hosted API on Unstructured infrastructure.
  • http://localhost:8000 - to access locally hosted API.
  • http://unstr-Appli-ausdah3ztNyq-1077627002.us-west-2.elb.amazonaws.com - to access AWS/Azure deployed API.
API key String/Expression

Specify the API key to access the Unstructured API endpoint. It is required for specific hosted versions.

Use the following methods for obtaining API keys, depending on the type of Unstructured API you are using:

  • Free Unstructured API: An API key is required for authentication. Obtain your API key by registering on the Unstructured website. Learn more.
  • Unstructured Serverless API: An API key is required for authentication. Obtain your API key and unique API URL by signing in on the Unstructured Serverless API page on their website. Learn more.
  • Self-hosted Unstructured: API key is not required, if authentication is disabled. You can enable the authentication for added security, for which an API key is required. Learn more.
Note: When you enable the expression for this masked field, the value becomes visible in plain text format.

Default value: N/A

Example: ab12cd34ef56gh78ij90kl12mn34op56
Read timeout (seconds) Integer/Expression

Specify the time in seconds to wait for a response from the Unstructured API. When you do not specify a value, the default timeout value is used. This field supports pipeline parameters.

Default value: 300

Example: 500

Troubleshooting

API key is missing

The API key was not provided in the request.

  • Ensure that you provide a valid API key and is not expired.
  • Verify the endpoint URL and refer to the API documentation.