Troubleshooting Unstructured API keys and URLs

Find the API key and URL for Business SaaS v1 or Transform v2, and troubleshoot authentication and host errors in your code.

Choose the API key for your product and version

For the Business SaaS v1 API (/api/v1/... endpoints), manage API keys in Business SaaS. For Business dedicated instance or in-VPC deployments, manage API keys through your deployment’s login page. Ask your Unstructured account administrator if you need the login URL. For the Transform v2 API (/api/v2/... endpoints), manage API keys in Transform.

Product	API version and example endpoint	Where to manage API keys
Business SaaS (Unstructured Pipelines)	v1: /api/v1/sources/	Business SaaS
Business dedicated instance or in-VPC	v1: /api/v1/sources/	Your deployment’s login page
Transform	v2: /api/v2/parse	Transform

How do I create an API key for the Business SaaS v1 API?

The following steps apply to Business SaaS. For a dedicated instance or in-VPC deployment, sign in through your deployment’s login page instead.

1. Sign in to Business SaaS

   Go to platform.unstructured.io and sign in.

2. Select your workspace

   Select your account and workspace. Each API key works with only one workspace.

3. Create an API key

   Click API Keys, then Generate New Key. Enter a name and click Continue.

4. Copy your API key and URL

   Next to the new API key, click the Copy icon and store the key securely.

   Next to Unstructured API Endpoint, click the Copy button to get the API URL for your workspace.

Use this Business SaaS API key and URL for your /api/v1/... requests. For Transform /api/v2/... requests, see Transform authentication.

Troubleshoot API keys and URLs

Failed to authenticate API Key

Issue: You receive an error such as the following:

Failed to authenticate API Key: API key is malformed, please type the API key correctly in the header.

Cause: The Unstructured API key that you supplied is not valid.

Solution: Check the original Unstructured API key against your code. To do so, follow one of these procedures, depending on your Unstructured product. If you are not sure which one to use, ask your Unstructured account administrator, or contact Unstructured Support.

Transform

These instructions apply to the Transform v2 API (/api/v2/... endpoints).

1. Go to https://transform.unstructured.io and sign in. If you are new, click Register.
2. Click API Keys.
3. Copy API Key and paste this value into a secure location. Compare this value to the one in your code, and make any changes to your code to match it as needed.

Business SaaS

These instructions apply to the Business SaaS v1 API (/api/v1/... endpoints).

1. Go to https://platform.unstructured.io and sign in.
2. Use the Unstructured account and workspace drop-down lists to pick which workspace you want to use with your API key. Each API key works with only one workspace.
3. Click API Keys.
4. Next to the API key you want to use, click the Copy icon. Paste this value into a secure location. Compare this value to the one in your code, and make any changes to your code to match it as needed.

Business dedicated instance or in-VPC

1. Go to your dedicated instance’s or in-VPC deployment’s login page and sign in. If you are not sure where it is, ask your Unstructured account administrator, or contact Unstructured Support.
2. Use the Unstructured account and workspace drop-down lists to pick which workspace you want to use with your API key. Each API key works with only one workspace.
3. Click API Keys.
4. Next to the API key you want to use, click the Copy icon. Paste this value into a secure location. Compare this value to the one in your code, and make any changes to your code to match it as needed.

Failed to find host

Issue: You receive an error such as the following:

httpcore.ConnectError: [Errno 8] nodename nor servname provided, or not known

Could not resolve host

Cause: The Unstructured API URL that you supplied is not valid.

Solution: Check the original Unstructured API URL against your code. To do so, follow one of these procedures, depending on your Unstructured product. If you are not sure which one to use, ask your Unstructured account administrator, or contact Unstructured Support.

Transform

These instructions apply to the Transform v2 API (/api/v2/... endpoints).

1. Go to https://transform.unstructured.io and sign in. If you are new, click Register.
2. Click API Keys.
3. Copy API URL and paste this value into a secure location. Compare this value to the one in your code, and make any changes to your code to match it as needed.

Business SaaS

These instructions apply to the Business SaaS v1 API (/api/v1/... endpoints).

1. Go to https://platform.unstructured.io and sign in.
2. Use the Unstructured account and workspace drop-down lists to pick which workspace you want to use with your API URL.
3. Click API Keys.
4. Next to Unstructured API Endpoint, click the Copy icon. Paste this value into a secure location. Compare this value to the one in your code, and make any changes to your code to match it as needed.

Business dedicated instance or in-VPC

1. Go to your dedicated instance’s or in-VPC deployment’s login page and sign in. If you are not sure where it is, ask your Unstructured account administrator, or contact Unstructured Support.
2. Use the Unstructured account and workspace drop-down lists to pick which workspace you want to use with your API URL.
3. Click API Keys.
4. Next to Unstructured API Endpoint, click the Copy icon. Paste this value into a secure location. Compare this value to the one in your code, and make any changes to your code to match it as needed.

Need more help? Contact Unstructured Support.