Skip to main content
API keys provide programmatic access to the Open Animate platform — use them in CI/CD pipelines, automated workflows, or any environment where browser login isn’t practical.

​
Create a key

Output:
The full key is only shown once at creation time. Store it securely.

​
List your keys

Shows all your keys with name, prefix, creation date, and last-used date.

​
Revoke a key

Immediately invalidates the key. Any requests using it will fail.

​
Using API keys

​
CI/CD login

This saves the key to ~/.oanim/credentials.yaml so subsequent commands use it automatically.

​
Resolution order

When making API calls, the CLI resolves credentials in this order:
  1. ANIMATE_API_KEY environment variable
  2. api_key in ~/.oanim/credentials.yaml (saved by oanim login)
Set the env var in your CI secrets to avoid needing oanim login in pipelines.

​
Key format

API keys use the anim_ prefix followed by a short identifier and a secret:
Only the prefix is stored on the server — the full key is hashed with SHA-256. This means if you lose it, you’ll need to create a new one.

​
Limits

Each account can have up to 10 API keys. Revoke unused keys to make room for new ones.