How to get started with the ClearRun hosted API

The hosted API lives at https://api.clearrun.net. Send an answer to POST /api/score, or send it with its question to POST /api/evaluate. A verified free account can create one developer key. A free account has 30 credits a month and can also score in the web app with Paste Check or chat.

Last updated

First steps

  1. Sign in

    Sign in at api.clearrun.net/login with Google, GitHub, or an email link. Your first sign-in creates an account.

  2. Create a key

    Open api.clearrun.net/account/keys and create a key. Copy it right away. It is shown only once.

  3. Send the key

    Send the key on every scoring request as Authorization: Bearer YOUR_KEY.

The endpoints you'll use first

Hosted API endpoints to start with
Method and pathNeeds a keyWhat it does
POST /api/scoreYesScores text you already have
POST /api/evaluateYesScores an answer, with the question if you have it
POST /api/chatYesGets an answer from a model, then scores it
GET /api/verify/{verdictId}NoLooks up a past verdict. Does not score

responseText is required for score and evaluate. Score, evaluate and chat accept text from 10 to 100,000 characters. See ClearRun limits.

A first request

curl -s https://api.clearrun.net/api/score \
  -H "Authorization: Bearer $CLEARRUN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "responseText": "The capital of France is Paris." }'

From the SDK, the same call is client.score({ responseText }). Full steps: How to score an answer with the API.