API Key

• Get your API key
• Set your API key when using the library
• Set your API key when calling the API directly

​

Get Your API Key

1. Log in to https://ade.landing.ai/.
2. Go to the API Key page (to navigate there manually, click your profile icon at the bottom left corner of the page and click API Key).
3. If you’re on a subscription plan, you can create an API key if needed.
4. Click the Copy icon to copy your API key.

​

Personal Plans (Explore Plans) Have One API Key

​

Create API Keys

1. Log in to https://ade.landing.ai/.
2. Go to the API Key page (to navigate there manually, click your profile icon at the bottom left corner of the page and click API Key).
3. If you’re not currently in the correct organization, select your organization from the drop-down menu.
4. Click Create Key.
5. Enter a brief, descriptive name for the API key in the key name field.
6. Click Create API Key.
7. Click the Copy icon to copy the API key.
8. Click Done to close the pop-up.

​

Revoke API Keys

1. Log in to https://ade.landing.ai/.
2. Go to the API Key page (to navigate there manually, click your profile icon at the bottom left corner of the page and click API Key).
3. If you’re not currently in the correct organization, select your organization from the drop-down menu.
4. Locate the row for the API key. (You may need to search to narrow down the list of API keys.)
5. Click the Settings button (ellipses) and select Revoke API Key. Follow the on-screen prompts to complete the process.

​

Set Your API Key When Using the Library

​

Method 1: Set the API Key as an Environment Variable

1. Set the environment variable. To persist the key across sessions on macOS or Linux, add the export command to your shell profile (.zshrc or .bashrc), then run source ~/.zshrc.
   macOS/Linux

   Windows (Command Prompt)

   Windows (PowerShell)

   export VISION_AGENT_API_KEY="<your-api-key>"
   
2. Initialize the client. It reads the VISION_AGENT_API_KEY environment variable automatically:
   from landingai_ade import LandingAIADE
   
   client = LandingAIADE()
   

​

Method 2: Store the API Key in a .env File

1. Install the python-dotenv package:
   pip install python-dotenv
   
2. Create a .env file in your project root and add your API key:
   VISION_AGENT_API_KEY=<your-api-key>
   
3. Load the .env file before you initialize the client:
   from dotenv import load_dotenv
   from landingai_ade import LandingAIADE
   
   load_dotenv()  # Populates the environment from .env.
   
   client = LandingAIADE()
   

​

Method 3: Set the API Key in a Notebook

1. In a notebook cell, set the environment variable:
   %env VISION_AGENT_API_KEY=<your-api-key>
   
2. Initialize the client in a later cell:
   from landingai_ade import LandingAIADE
   
   client = LandingAIADE()
   

​

API Key Precedence

1. The apikey passed to the client constructor.
2. The VISION_AGENT_API_KEY environment variable, whether you set it directly or loaded it from a .env file. A value already set in your environment is not overridden by a .env file.

​

Set Your API Key When Calling the API Directly

​

Security Best Practices

• If using a .env file: Add .env to .gitignore to prevent accidentally committing the API key to version control.
• Do not hard-code the API key in your source code, because others could see and use your API key. Passing a variable that holds the key (for example, from a secrets manager) is fine.

​

Troubleshoot API Key Issues

​

Error: Missing API Key

landingai_ade.LandingAiadeError: The apikey client option must be set either by passing apikey to the client or by setting the VISION_AGENT_API_KEY environment variable

LandingAIADEError: The VISION_AGENT_API_KEY environment variable is missing or empty; either provide it, or instantiate the LandingAIADE client with an apikey option, like new LandingAIADE({ apikey: 'My Apikey' }).

​

.env File Issues

• Check file location: The .env file should be in the same directory where you run your script.
• Verify file format: No spaces around the equals sign:
  # Correct
  VISION_AGENT_API_KEY=<your-api-key>
  
  # Incorrect
  VISION_AGENT_API_KEY = <your-api-key>
  

​

Environment Variable Issues

• Restart your application after setting environment variables.
• Check variable name: Must be exactly VISION_AGENT_API_KEY.
• Check if the environment variable is correct:
  macOS/Linux

  Windows (Command Prompt)

  Windows (PowerShell)

  echo $VISION_AGENT_API_KEY
  
• Ensure that you apply the changes after setting, changing, or removing the environment variable:
  • Linux/macOS: Restart your terminal. If you added the variable to your .zshrc file, run source ~/.zshrc.
  • Windows: Close and reopen Command Prompt/PowerShell, or restart your IDE.

​

Wrong API Key Used

1. You create an account with your personal email address and set the API as an environment variable.
2. A few weeks later you create an account with your work email address and store the API key for that account in a .env file.
3. When you run , it uses the first API key, because the environment variable takes precedence over the .env file.

​

Error: Missing Authorization Header

headers = {"Authorization": f"Bearer {api_key}"}

​

Error: User Not Found, Please Check Your API Key

• Verify the API key: Copy your key directly from the dashboard.
• Restart your environment: Close and reopen your terminal, IDE, or Jupyter notebook.