Authentication
To authenticate API requests, you'll need to create an API key from OlmoEarth Studio.
Creating an API Key
- Log into OlmoEarth Studio
- Click the menu icon in the top right corner and select My Profile
- In the API Keys section, click Create new API key
- Enter a descriptive name for your key (e.g., "Production CI/CD" or "Local Development")
- Choose the key's restrictions (see Restricting an API key)
- Click Create
- Copy your API key immediately using the copy button
Store your API key securely. The full key is only shown once at creation. If you lose it, you'll need to create a new one.
Restricting an API Key
Every key carries its own restrictions, so you can give each integration only the access it needs. A key can never do more than you can: it acts as you, limited further by these settings.
- Access: read-only or read/write.
- Permissions: which of your permissions the key can use.
- Organization: one of your organizations, or all of them.
- Expiration: when the key stops working.
You can change any of these settings later from your profile page.
Using Your API Key
Include the API key in the Authorization header as a bearer token:
curl -H "Authorization: Bearer YOUR_API_KEY" "https://olmoearth.allenai.org/api/v1/..."
If you're using the Interactive OlmoEarth API Browser, paste your API key in the Authentication box to make requests directly.
Managing API Keys
From your profile page, you can:
- View all your keys - See key names, access, permissions, organization, expiration, creation dates, and last used timestamps. Expired keys are marked Expired.
- Edit keys - Rename a key or change its access, permissions, organization, or expiration
- Delete keys - Permanently revoke a key (applications using it will stop working)
You can have up to 10 unexpired API keys per account; expired keys stay listed until you delete them but don't count.
When a key isn't allowed to make a request, the error message says why: for example, the key has expired, is read-only, or doesn't carry a permission the route needs.
Use separate API keys for different applications or environments. This makes it easy to rotate or revoke access without affecting other integrations.
OlmoEarth API Endpoints
OlmoEarth API endpoints are documented in the Interactive OlmoEarth API Browser.
You can use it to understand request and response schemas, make requests directly to the API, and generate client code in many common languages and libraries.