API Key

• Get your API key
• Set your API key when using a 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 a Library

export VISION_AGENT_API_KEY="<your-api-key>"

set "VISION_AGENT_API_KEY=<your-api-key>"

$env:VISION_AGENT_API_KEY="<your-api-key>"

​

Set Your API Key When Calling the API Directly

​

Security Best Practices

• 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.

​

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.