Lexicon Garden

social.coves.aggregator.createApiKey

Create an API key for the authenticated aggregator. Requires OAuth authentication. The API key is returned ONCE and cannot be retrieved again. Store it securely.

Repository @coves.social did:web:coves.social namespace authority
Details · procedure
Kindprocedure
Authorityaggregator.coves.social
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

Output

application/json

createdAt

requiredstring · datetime

ISO8601 timestamp when the key was created

did

requiredstring · did

DID of the aggregator that owns this key

key

requiredstring

The plain-text API key. This is shown ONCE and cannot be retrieved again. Format: ckapi_<64-hex-chars> (32 bytes hex-encoded)

  • maxLength: 256

keyPrefix

requiredstring

First 12 characters of the key (e.g., 'ckapi_ab12cd') for identification in logs and UI

  • maxLength: 64

Errors

AuthenticationRequired

OAuth authentication is required to create an API key

OAuthSessionRequired

OAuth session is required (not service JWT) to create an API key

AggregatorRequired

Only registered aggregators can create API keys

KeyGenerationFailed

Failed to generate the API key

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • dev.cocore.account.createApiKey

    procedure

    Mint a new cocore API key for the authenticated account. Authenticate with either a console session cookie or an existing `Authorization: Bearer cocore-...` key. The full secret is returned exactly once in `secret` and is never retrievable again — only its SHA-256 hash is stored. Use the returned key to authenticate subsequent automated requests (inference, the record proxy, and these key-management methods themselves).

  • social.coves.aggregator.getApiKey

    query

    Get information about the authenticated aggregator's API key. Note: The actual key value is NEVER returned - only metadata about the key.

  • social.coves.aggregator.revokeApiKey

    procedure

    Revoke the authenticated aggregator's API key. After revocation, the aggregator must complete OAuth flow again to create a new API key. This action cannot be undone.

  • dev.cocore.account.listApiKeys

    query

    List every API key belonging to the authenticated account, most-recently-created first. The owning DID is derived from the credential presented (session cookie or `Authorization: Bearer cocore-...`); there is no way to list another account's keys. Secrets are never returned — see `apiKeyView`.