API keys and the API
Create a key, choose what it can do, and call the Cyrus API.
The Cyrus API lets your own tools and scripts do what the app does.
Create a key
Open Account, then API keys, and choose Create key. Give it a name and tick the permissions it needs.
- The key is shown once. Copy it then. Cyrus stores only a fingerprint and cannot show it again.
- Keys can be revoked at any time. Revoke a key if you think it leaked.
- Give a key the smallest set of permissions that works.
Permissions
Read projects, change projects, read builds, start builds (spends tokens), read and request installs, search the catalog, change mod settings, contribute to the library, read account and token balance.
Calling the API
Send the key as a bearer token on requests to the versioned API. Requests that start a build or install take an idempotency key, so a retry never builds twice. Builds started by API use your tokens and your plan, with the same limits as the app.
What exists today
Reading and creating projects, starting and reading builds, installing and reading installs, changing mod settings, searching the catalog, and contributing library assets. More operations are planned and listed in the API reference as such. Webhooks for build and install results are being rolled out.
Limits
Keys are rate limited. Calls that exceed the limit get a clear error with when to retry.
Related: plans and tokens.
Open a Nxeon support ticket and tell us the project name. We can see your build details when you open it from the build page.