Mint an API key by submitting a signed challenge.

Verifies the signature against the most recent unconsumed challenge for the address and returns the plaintext key. The plaintext is shown EXACTLY ONCE; the server stores only sha256(plaintext).

POST /v1/auth/keys

Error

A valid request URL is required to generate request examples

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "keyPrefix": "<string>",
  "ownerAddress": "<string>",
  "scopes": [
    "<string>"
  ],
  "rateLimitPerMin": 0,
  "createdAt": "<string>",
  "lastUsedAt": "<string>",
  "revokedAt": "<string>",
  "name": "<string>",
  "key": "<string>"
}

Authorizations

Authorization · string · header · required

API key obtained from POST /v1/auth/keys.

Body

application/json

address · string · required

Alephium address (base58, optional :N group suffix).

Required string length: 30 - 80

Pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$

publicKey · string · required

Public key whose hash equals address (33-byte secp256k1, hex).

Pattern: ^(0x)?[0-9a-fA-F]+$

signature · string · required

Signature produced by signMessage(challenge, "alephium") (64 bytes hex).

Pattern: ^(0x)?[0-9a-fA-F]+$

name · string

Optional human label.

Required string length: 1 - 80

Response

200

application/json

Default Response

id · string<uuid> · required

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

keyPrefix · string · required

ownerAddress · string · required

Alephium address (base58, optional :N group suffix).

Required string length: 30 - 80

Pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$

scopes · string[] · required

rateLimitPerMin · integer | null · required

Required range: -9007199254740991 <= x <= 9007199254740991

createdAt · string · required

lastUsedAt · string | null · required

revokedAt · string | null · required

name · string | null · required

key · string · required

PLAINTEXT API key — store this immediately; it cannot be retrieved later.