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 at Account > API Access. See Account & API Keys for that, and the API Reference 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.

​
Scope catalog

Scopes are category:access. Access is either read or write, and write implies read for the same category.
papers is read-only; there is no papers:write. The deprecated models/datasets surface is not in the scope catalog; those routes are reachable only with a legacy full-access key.

​
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. A digest bot scoped to one interest is a common case.

​
Presets

When creating a key you can apply a one-click preset instead of picking scopes by hand: You can always edit the scope set after applying a preset, before creating the key.

​
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; keys are immutable once created.

Account & API Keys

Create, scope, and revoke named keys

API Reference

REST endpoints and authentication

Connectors

OAuth connections (GitHub, HuggingFace, and more)

CLI

Authenticate the CLI with a personal key