Account, Billing, and API Keys
Use Settings to manage your account, execution machines, billing state, API keys, and app preferences.
Account
The account section includes profile, subscription, credits, and connected OAuth accounts.
Profile
In Settings -> Profile, you can update:
- Avatar
- Username
- Email address
Usernames and email addresses must be unique. If another account already uses the value, the app shows a validation error.
OAuth Accounts
Connected OAuth accounts let Agentrix access providers such as GitHub or GitLab on your behalf. Repository mode uses these connections to list repositories, issues, and merge requests.
If repository access fails, return to Settings and confirm the expected OAuth account is connected.
Subscription
Open Settings -> Subscription to view your current plan and available plans. When billing is configured for the deployment, this screen can:
- Show the current plan, renewal or expiry date, monthly price, and included credits.
- Open the customer portal to manage an active subscription.
- Start checkout for a new plan.
- Show plan features and highlight the popular plan when configured.
If the screen says subscription features are not configured, the deployment administrator has not enabled billing for that environment.
Credits
Open Settings -> Credits to see account balance, active credit packages, and transaction history.
The credits screen shows:
- Total current balance.
- Active credit buckets and expiry dates.
- Recharge options when credit packages are available.
- Transaction history for recharge and usage events.
Refresh the screen if a recent payment or usage event has not appeared yet. The app also listens for billing updates over WebSocket while the credits screen is open.
Devices
Local Machines
Open Settings -> Local Machines to see machines bound to your account. The list shows online status, host information, platform, and CLI version where available.
You can unbind a local machine from this screen. Unbinding removes the machine's association with your account. The next agentrix start on that machine needs authentication again.
Private Clouds
Open Settings -> Private Clouds to create and manage team runner pools. Private Clouds are covered in detail in Private Cloud Setup.
Preferences
The preferences section lets you adjust:
- Layout
- Theme and appearance
- Language
These preferences affect the app UI only. They do not change daemon behavior.
Privacy
Open Settings -> Privacy to view, copy, or change the local account entry password used by the app's encryption and restore flows.
Treat this password as sensitive. Anyone with the password and the required account context may be able to restore protected data.
API Keys
API keys are used by automation such as agentrix-run, GitHub Actions, GitLab CI, and custom scripts.
Open Settings -> API Keys to:
- Create a key with a name.
- Copy the key once from the reveal modal.
- See the key prefix, last-used time, expiry, and enabled state.
- Delete keys you no longer use.
Store API keys in a secret manager or CI secret store. Agentrix only shows the full key immediately after creation.
Common Read-Only Endpoints Available With API Keys
An API key can be used as a bearer token for these common read-only endpoints. Some endpoints return secrets, encryption keys, or credential-bearing URLs; treat those values as sensitive:
Authorization: Bearer YOUR_API_KEY
| Area | Endpoint | Description |
|---|---|---|
| Account | GET /v1/auth/me | Get the current user profile, OAuth accounts, and Git server accounts. |
| API Keys | GET /v1/api-keys | List API key metadata for the current account. Full keys are not returned again. |
| Billing | GET /v1/billing/balance | Get the current credits balance. |
| Billing | GET /v1/billing/packages | List credit packages for the current account. |
| Billing | GET /v1/billing/transactions | List billing transactions for the current account. |
| Billing | GET /v1/billing/transactions/task/:taskId | List billing transactions for a task. |
| Billing | GET /v1/billing/stats | Get account usage statistics. |
| Subscription | GET /v1/subscription | Get the current subscription and entitlement. |
| Config | GET /v1/openapi-config | Get the LLM gateway base URL, default API key, and model configuration. Treat the response as sensitive. |
| Environment Variables | GET /v1/environment-variables | Get environment variables for an owner. The current account must own that owner. |
| Local Machines | GET /v1/machines | List local machines, cloud runners, and private cloud runners available to the current account. Local machine entries include the account's dataEncryptionKey. |
| Local Machines | GET /v1/machines/:machineId/models | List models currently available on an online local machine. |
| Private Clouds | GET /v1/machines/clouds/:cloudId/models | List models currently available on an online private cloud runner. |
| Private Clouds | GET /v1/private-clouds | List private clouds joined by the current account and private cloud entitlement. |
| Private Clouds | GET /v1/private-clouds/:id/machines | List runner machines for a private cloud. |
| Private Clouds | GET /v1/private-clouds/:id/members | List private cloud members. |
| Private Clouds | GET /v1/private-clouds/:id/runner-secret | Get the runner secret. Only owners or admins should call this endpoint; treat the value as a secret. |
| Auth Requests | GET /v1/auth/machine/status | Get approval status for a local machine auth request. |
| Auth Requests | GET /v1/auth/cloud | Get the approval result for a private cloud join request. |
| Auth Requests | GET /v1/auth/cloud/status | Get pending status for a private cloud join request. |
| Workspaces | GET /v1/workspaces | List workspaces for the current account. |
| Chats | GET /v1/chats | List chats available to the current account. |
| Chats | GET /v1/chats/:chatId | Get chat details. |
| Chats | GET /v1/chats/:chatId/members | List chat members. |
| Chats | GET /v1/chats/:chatId/tasks | List tasks in a chat. |
| Tasks | GET /v1/tasks | List tasks. |
| Tasks | GET /v1/tasks/:taskId | Get task details. |
| Tasks | GET /v1/tasks/:taskId/events | Query task event history. |
| Tasks | GET /v1/tasks/:taskId/patch | Get a task patch. |
| Tasks | GET /v1/tasks/:taskId/project/* | Read project files from a task workspace. |
| Tasks | GET /v1/tasks/:taskId/channel-attachment | Read a channel attachment. |
| Tasks | GET /v1/tasks/sub-tasks | List direct sub-tasks. |
| Tasks | GET /v1/tasks/recent | List recent tasks. |
| Tasks | GET /v1/tasks/find-by-agent | Find an existing task by agent. |
| Repositories | GET /v1/inbox | List repository inbox items for the current account. |
| Repositories | GET /v1/repos/install-url | Get a GitHub App installation URL. |
| Repositories | GET /v1/repos | List repositories authorized for the current account. |
| Repositories | GET /v1/repos/:repoId | Get repository details by repository ID. |
| Repositories | GET /v1/repos/:repoId/inbox | List inbox items for a repository. |
| Repositories | GET /v1/repos/:owner/:repo | Get repository details by owner/name. |
| Repositories | GET /v1/repos/:owner/:repo/git-url | Get an authenticated Git URL. Treat the URL as sensitive. |
| Repositories | GET /v1/repos/:owner/:repo/branches | List branches. |
| Repositories | GET /v1/repos/:owner/:repo/issues | List issues. |
| Repositories | GET /v1/repos/:owner/:repo/issues/:number | Get issue details. |
| Repositories | GET /v1/repos/:owner/:repo/issues/:number/comments | List issue comments. |
| Repositories | GET /v1/repos/:owner/:repo/references | List issues, pull requests, or merge requests. |
| Repositories | GET /v1/repos/:owner/:repo/references/:number | Get reference details. |
| Repositories | GET /v1/repos/:owner/:repo/references/:number/comments | List reference comments. |
| Repositories | GET /v1/repos/:owner/:repo/references/:number/inline-comments | List inline comments. |
| Repositories | GET /v1/repos/:owner/:repo/references/:number/activity | List reference activity. |
| Repositories | GET /v1/repos/:owner/:repo/references/:number/diff | Get reference diff. |
| Git integrations | GET /v1/git-servers | List available Git servers. |
| Git integrations | GET /v1/git-servers/:gitServerId | Get Git server details. |
| Git integrations | GET /v1/git-servers/:gitServerId/apps | List Git server apps. |
| Git integrations | GET /v1/git-apps | List Git apps for the current account. |
| Git integrations | GET /v1/git-apps/:appId/repositories | List repositories under a Git app. |
| Files | GET /v1/files | List files for the current account. |
| Files | GET /v1/files/:fileId | Get a redirect URL for an accessible file download. |
| Contacts | GET /v1/contacts | List contacts. |
| Contacts | GET /v1/contacts/candidates | Search contact candidates. |
| Agents | GET /v1/agents | List agents. |
| Agents | GET /v1/agents/user/:userId | List agents published by a user. |
| Agents | GET /v1/user-agents | List current account agents and draft agents. |
| Agents | GET /v1/agents/:agentId | Get agent details. |
| Agents | GET /v1/agents/:agentId/git-url | Get a published agent's Git URL. Treat the URL as sensitive. |
| Hive | GET /v1/hive/me | List Hive listings you published. |
| Hive | GET /v1/hive/installed | List Hive listings you installed. |
Some public browsing endpoints do not require an API key, including GET /v1/resources, GET /v1/hive/listings, GET /v1/hive/listings/:id, and GET /v1/hive/trending.
Safe API Key Rotation
- Create a new key with a clear name, for example
github-actions-agentrix. - Update the CI secret or automation environment.
- Run the automation once and confirm the new key works.
- Delete the old key from Settings -> API Keys.
For agentrix-run, set the key through AGENTRIX_API_KEY or the GitHub Action api-key input. See agentrix-run for CI examples.