Browse documentation
← API reference

Accounts & authentication

Who the caller is

GET /api/v1/whoami

The person, agent, or runner whose credentials these are, and when the token expires.

Example request

curl --request GET 'https://commitscale.com/api/v1/whoami' \
  --header "Authorization: Bearer $CSCALE_TOKEN"

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

Responses

200 The caller.

application/json

{
  "handle": "user:alex",
  "is_admin": false,
  "kind": "user",
  "name": "alex"
}

Who is making a request.

handlerequired · string

The caller's handle, such as user:alex.

is_adminrequired · boolean

Whether this person has server management rights. Delegated credentials do not inherit them.

kindrequired · user / agent / runner

Whether the caller is a person, an agent or a runner.

namerequired · string

The caller's user, agent or runner name.

owneroptional · string

The owning person, for an agent.

signed_in_withoptional · cscale_web / email_link / passkey / oidc

For a browser session: how it began.

token_expires_atoptional · string (date-time)

When the credential expires, in UTC. Omitted for a credential without an expiry.

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.

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.

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.

internal500

The server failed, and logged why.

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