Accounts & authentication

Give another agent a check-only key

POST /api/v1/check-keys

Creates a check-only key for another agent. The person's CLI sign-in or a browser session signed in within 10 minutes can create a named key while their passkey layer is off. Phone tokens and browser API tokens cannot. With the layer on, returns passkey_layer_required; use the confirmed route. Creates an owned agent with no repository grants. The key lasts 90 days and is shown once, never stored or replayed. No caller can widen or refresh it. Broader agent powers retain their passkey requirement.

Parameters

Idempotency-Keyheader · optional · string

Makes a retry safe: a request with the same key and the same method, path, and body as an earlier one gets the earlier response instead of doing the work again. 1 to 255 visible ASCII characters; use a new key for each new request, such as a UUID. Keys are kept per caller for a day, and ignored for requests without credentials.

Minimum length: 1 · Maximum length: 255

Example request

curl --request POST 'https://commitscale.com/api/v1/check-keys' \
  --header "Authorization: Bearer $CSCALE_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My coding agent"
}'

Example values illustrate the format. Use your own credentials and identifiers.

Request body

application/json

namerequired · string: Label for the key, between 1 and 60 plain characters.

Responses

200 The key, shown once.

application/json

{
  "key": {
    "agent": "agent:check-1@alex",
    "created_at": "2026-10-26T10:00:00Z",
    "expires_at": "2026-10-26T10:00:00Z",
    "id": 1,
    "last_used_at": "2026-10-26T10:00:00Z",
    "name": "My coding agent",
    "revoked_at": "2026-10-26T10:00:00Z"
  },
  "token": "cs_chk_example"
}

keyrequired · object

Metadata for the newly issued key. The separate token field is shown once.

Fields of key

agentrequired · string: Handle of the check-only agent using this key.
created_atrequired · string (date-time): When this record was created, in UTC.
expires_atrequired · string or null (date-time): Empty until the agent collects the key.
idrequired · integer (int64): Numeric check-key identifier used for renaming and revocation.
last_used_atrequired · string or null (date-time): Recorded at most once a minute, as for other tokens.
namerequired · string: The person's label for this key, between 1 and 60 plain characters.
revoked_atrequired · string or null (date-time): When the key was revoked, in UTC; null while it has not been revoked.

tokenrequired · string

Shown once. It cannot create or refresh credentials.

RateLimit and RateLimit-Policy describe the request rate. Follow Retry-After when a response asks you to wait.

Problem responses

Errors use application/problem+json. Act on the stable code, and follow next when present. See the problem format.

passkey_layer_required403

The person enabled the passkey layer. Direct check-key creation is refused.

Run cscale key create to confirm with a passkey, or use POST /api/v1/check-keys/confirmed.

check_key_scope403

A check-only key may call the test check, read its own usage and acceptance rule, contact support, and withdraw data sharing.

Use a person's sign-in for account management. More agent power needs the owner's passkey; this key cannot widen itself.

feature_off403

The namespace plan does not include this feature.

Retrying on the same plan will not help. GET /api/v1/namespaces/{namespace}/plan, and the namespace's Plan page in Settings, show what its plan includes.

unauthenticated401

The request carried no credentials.

Use this operation's sign-in method. Bearer credentials use Authorization: Bearer <token>; browser credentials use the session cookie.

invalid_token401

The token is unknown, expired, or revoked, its agent was revoked, or an OAuth token was used outside its MCP resource.

Stop using it. Sign in again, or ask the owner to create a replacement agent key.

forbidden403

The caller may not do this: only people may, only owners may, or the agent was not given this repository or write access.

Stop. Retrying will not help. Ask the owner for the access, or leave the step to a person.

invalid_request400 / 413 / 415 / 422

The request is malformed or breaks a rule, such as a title that is too long, or a body that is not the expected JSON.

Fix the request as detail says. The same request fails the same way.

quota_exceeded429

With 429, the caller used its requests for the minute. With 422, a count limit was reached.

With 429, wait Retry-After seconds and retry. With 422, remove one first.

idempotency_key_reused409 / 422

The idempotency key was already used for a different request.

Use a new key for each new request, and the same key only for a retry of the same request.

idempotency_key_in_use409

The first request with this key is still running, including a queued model question, or it succeeded with a secret, such as a new token, which is never replayed.

When Retry-After is set, retry then with the same key. Otherwise the first request succeeded: do not repeat it.

internal500

The server failed, and logged why.

Retry after Retry-After seconds. A write is safe to retry with the same idempotency key.

unavailable503

With 502, a service the server needs did not answer, such as a sign-in provider. With 503, the server is busy, such as when a workspace is locked or host lookups are full, or a write with an idempotency key runs long: that write goes on, and its answer is kept for the key.

With 502, retry later, or sign in another way. With 503, retry after Retry-After seconds, using the same idempotency key for a write; a long-running write can then replay its answer.