Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.landing.ai/llms.txt

Use this file to discover all available pages before exploring further.

Calling the API requires an API key.

​
Get Your API Key

If using in the EU, get your API key here.
Get your API key on the API Key page:
  1. Log in to https://va.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). Navigate to 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. API Key

​
Personal Plans (Explore Plans) Have One API Key

The personal plan (the “Explore” plan) only has one API key. This API key cannot be deleted or revoked. The Explore plan type is designed for testing, prototyping, and hobby use. If you’d like to deploy to production and need more granular API key management, like the ability to create and revoke API keys, upgrade to a subscription plan.
If your API key is exposed or leaked and you’d like to request a new API key, contact support@landing.ai

​
Create API Keys

If you are on a Team or Enterprise plan, you can create multiple API keys for your organization to use. To create an API key:
  1. Log in to https://va.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). Navigate to 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

If you are on the Team or Enterprise plan, you can revoke API keys. A user with the Admin role can revoke any API key. A user with the Developer role can revoke only API keys they have created. To revoke an API key:
  1. Log in to https://va.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). Navigate to 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 Calling the API Directly

Include the API key in request headers. To see code samples, go to API.

​
Security Best Practices

  • Do not pass the API key directly to the code, because others could see and use your API key.

​
Troubleshoot API Key Issues

Use the troubleshooting tips in this section to resolve issues related to API keys.

​
Error: Missing Authorization Header

This error occurs if the authorization header is not included when calling the API directly. To fix this, include the API header: 
headers = {"Authorization": f"Bearer {api_key}"}

​
Error: User Not Found, Please Check Your API Key

This error occurs when the API key is entered incorrectly. To resolve this issue:
  • Verify the API key: Copy your key directly from the dashboard.
  • Restart your environment: Close and reopen your terminal, IDE, or Jupyter notebook.