Skip to main content
Remyx API keys are opaque, named tokens that carry an explicit set of scopes. Each scope gates which routes a key can call: a request to a route the key isn’t scoped for returns 403 Forbidden. Create and manage keys under Account > API keys. See Account for that, and the API authentication for how scopes appear in REST calls.

Key prefixes

Every key’s prefix tells you what it’s for and how long it lives: Both are opaque (prefix + base62 entropy + CRC32 checksum). Remyx stores only sha256(key). The plaintext is shown once at creation, then rendered as rmxu_…last4 for identification. You create personal keys only. Automation keys are minted for you when you provision an agent (remyxai outrider init, setup-local, or the studio), with scopes fixed to what that repo’s workflow calls (see Automation key scopes). You can rename or revoke an automation key; revoking it pauses the agent. A key’s name and scopes can be edited after creation (PATCH /account/api-keys/<id>); automation keys accept a rename only. Revoking keeps the key listed for audit; deleting removes it.

Scope catalog

Scopes are category:access. Access is either read or write, and write implies read (and refresh, where a route declares it) for the same category. This table is generated from the engine’s scope registry and is what the key form shows.
integrations:read is broader than its name suggests. Besides connection status, it gates GET /integrations/<provider>/token, which returns the decrypted credential for a connected service (an OAuth access token, or an API key you pasted). Grant it only to keys you would trust with those credentials. The Read-only preset deliberately leaves it out.
account and papers are read-only; there is no account:write or papers:write. Profile and team settings change in the studio, not through a key. The deprecated models/datasets surface is not in the catalog; those routes are reachable only with a full-access key.

Full access

A key created without a scope list is full access (*): every route, including the key-management and provisioning routes that take no scoped alternative. The studio’s key form asks you to pick features or choose full access explicitly; an empty scope list is rejected rather than silently becoming full access.

Resource-qualified grants

A scope can be narrowed to a specific resource by appending its UUID:
Use resource-qualified grants when a key should touch a single resource rather than the whole category. Routes that resolve a resource (for example GET /research-interests/<id>) honour them; the provisioning flows mint them for automation keys.

Presets

When creating a key you can apply a one-click preset instead of picking scopes by hand. Presets are starting points; the stored scopes are ordinary catalog entries you can adjust before creating the key. All presets are personal (rmxu_) keys, since that is the only kind you can create. The Outrider setup preset needs only github:read: the github:write bot-token mint belongs to the automation key the provisioning flow creates.

Automation key scopes

The rmxa_ key Outrider provisioning writes into a repo’s secrets carries exactly the surface the workflow exercises: The same set is minted by the App-install path and setup-local, so the two installs stay interchangeable.

Which surface needs what

Prefer a narrowly scoped key per use over one broad key everywhere. To rotate, create a new key and revoke the old one.

Account

Create, scope, expire, and revoke named keys

API Reference

REST endpoints and authentication

Connectors

OAuth and API-key connections

CLI

Authenticate the CLI with a personal key