How to store and revoke ClearRun API keys

Create keys at https://api.clearrun.net/account/keys. The full key is shown once, so copy it right away. A verified free account can create one developer key. Keep it in an environment variable or save it with clearrun login. If a key may have leaked, revoke it on the API keys page.

Last updated

Create a key

  1. Sign in

    Sign in at api.clearrun.net/login.

  2. Create a key

    Open Account keys and create a key.

  3. Copy the key

    Copy it immediately. You cannot view the full key again. It starts with crun_.

Only a SHA-256 hash is stored. A lost key cannot be displayed again. Create a new one. To stop the old one, revoke it. See How to revoke a ClearRun API key.

Store it

  • Environment variable: CLEARRUN_API_KEY. This overrides a saved login.
  • This machine only: npx @clearrun/cli login writes ~/.config/clearrun/config.json with mode 0600. clearrun logout removes it.
  • Request header: Authorization: Bearer plus the key.

Do not commit a key, and do not put a real key in a screenshot or a ticket. If a key may have leaked, revoke it on the API keys page and email contact@adepoco.com. See How to revoke a ClearRun API key. You are responsible for activity under your keys. See the Terms.

What a key can do

A free developer key, and a key on a paid plan with API access on, can call score, evaluate, and chat. Those calls spend credits. GET /api/verify/{id} is public and does not use the key. Chat costs at most 4 credits per turn. A key that is not a free developer key gets 403 API_ACCESS_REQUIRED on a free account. Turning API access off stops paid keys. It does not turn a free developer key off.