Skip to main content

Unstructured API key

This key is for Read and Vision. It is not the key on an ML, Forecast, Loop, or Resolve page. Skip it if you are training on a table.

How to get your key​

  1. Sign in at heimdallapp.org
  2. Either:
    • Sidebar footer → Looking for unstructured? (opens Settings), or
    • Sidebar → Account → API keys (/settings?section=api-keys)
  3. Click Generate. Copy the key on that screen. It is not shown again. Generate a new one if you lose it, and update the apps that stored the old key.

What You Can Do with Your Unstructured API Key​

Your single unstructured API key gives you access to:

  • Read sends one string and returns counts, a sentiment label, and a 64-number embedding
  • Vision sends one image file and returns histograms, gradients, textures, or keypoints

Using Your Unstructured API Key​

Include your unstructured API key in the headers of all API requests for both text and image analysis:

headers = {
    'X-api-key': 'YOUR-UNSTRUCTURED-API-KEY',
    'X-username': 'YOUR-USERNAME'
}

The request and the field list are on Read and Vision. Do not copy a sample response from this page. Counts come from the tokenizer for the string you send.

Security Best Practices​

  • Never commit API keys to version control
  • Use environment variables to store API keys
  • Rotate keys regularly for security

Lake vs unstructured key​

NeedUse
One text/image per API callThis key → Read/Vision
Thousands of files for ML trainingLake → Add data → Unstructured zip: no unstructured key required for ingest

Next steps​

  1. First API call
  2. Unstructured suite overview
  3. Tabular ML? → User journeys (Lake path, not this key)