Skip to main content

Prerequisites

  1. A 0xkey organization (Quickstart)
  2. Access to the Dashboard to register an API public key on your user

Install 0xkey

From source / releases

Homebrew

The formula name is oxkey (Homebrew Ruby classes cannot start with a digit). The installed binary is still 0xkey:
Source and verification notes: 0xkey-io/cli.

Find your organization ID

All API requests require an organization ID. Copy it from the Dashboard user menu, then:
Environment variables use the ZEROXKEY_ prefix (never 0XKEY_ — POSIX forbids names that start with a digit).

Generate an API key

The CLI stores the private key under ~/.config/0xkey/keys/ (mode 0600). Copy the publicKey from the JSON output. Persist non-secret defaults (optional):

Register the public key

In the Dashboard: My Profile → New API key → Advanced Settings, paste the CLI-generated public key, and approve with your authenticator.

Whoami

Create a wallet and Ethereum account

Stamp a Public API request

Paths use 0xkey Public API style: /public/v1/query/* and /public/v1/submit/*.
Preview the stamp and curl without posting:
Or use the typed helper:

Shared config contract

The same layout is shared with AgentOS tooling (0xkey-wallet). Private keys are never written into config.toml.

Next steps