Accounts & authentication
Accept an invite from an email link
POST /api/v1/auth/invites/accept
Accepts an invitation from its emailed link. For the web app's own pages only. For an address without an account, creates it under name, even while signup is closed, and signs the browser in. For an address with one, only a browser already signed in to that account accepts: the link alone never signs in. Then it joins the invite's organization, if it names one. An organization owner's invites create at most five accounts a day, only at the domains signup takes, if it names any, and none if the owner's own account came from an owner's invite.
Parameters
Originheader · required · stringThis server's origin. Required for this browser sign-in step.
Idempotency-Keyheader · optional · stringMakes 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/auth/invites/accept' \
--header 'Origin: https://commitscale.com' \
--header 'Content-Type: application/json' \
--data '{
"token": "email-fragment-token"
}'Example values illustrate the format. Use your own credentials and identifiers.
Request body
application/json
A one-time link's token, from /login/continue#token=…. A signup also names the account to create.
data_sharingoptional · objectOnly for account creation, from the person's confirmation form.
Fields of
data_sharingopted_inrequired · booleanWhether the person explicitly chose to share scrubbed Free-plan check data.
wording_versionoptional · stringRequired and current when opting in. Withdrawal needs no version.
nameoptional · stringPublic username to create when accepting a sign-up ticket.
tokenrequired · stringOne-time secret from the sign-in or invitation link's fragment.
Responses
200 Accepted: the person, signed in.
application/json
{
"handle": "user:alex",
"is_admin": false,
"kind": "user",
"name": "alex"
}Who is making a request.
handlerequired · stringThe caller's handle, such as user:alex.
is_adminrequired · booleanWhether this person has server management rights. Delegated credentials do not inherit them.
kindrequired ·user/agent/runnerWhether the caller is a person, an agent or a runner.
namerequired · stringThe caller's user, agent or runner name.
owneroptional · stringThe owning person, for an agent.
signed_in_withoptional ·cscale_web/email_link/passkey/oidcFor 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.
organization_person_limit403The organization's Free plan allows one person.
An owner can upgrade the organization to Pro, or ask an owner to do so.
check_key_scope403A 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.
signup_closed403Open sign-up is turned off on this server.
Ask for an invite, or sign in to an existing account.
feature_off403The 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.
invalid_token401The 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.
forbidden403The 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.
already_exists409Something with that name exists, or its current state does not allow this request.
Use the one that exists, or choose another name.
invalid_request400 / 413 / 415 / 422The 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
detailsays. The same request fails the same way.quota_exceeded422 / 429With 429, the caller used its requests for the minute. With 422, a count limit was reached.
With 429, wait
Retry-Afterseconds and retry. With 422, remove one first.idempotency_key_reused409 / 422The 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_use409The 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-Afteris set, retry then with the same key. Otherwise the first request succeeded: do not repeat it.expired_token400A device login code, sign-up, sign-in link, or passkey prompt expired or was already used.
Start a new flow. If a sign-up already created the account but its key was lost, the person signs in to revoke and replace that key.
access_denied400A device login was denied or refused after five wrong codes, or the passkey does not sign in here.
Stop. After five wrong codes, start a new login; otherwise, sign in another way.
internal500The server failed, and logged why.
Retry after
Retry-Afterseconds. A write is safe to retry with the same idempotency key.unavailable503With 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-Afterseconds, using the same idempotency key for a write; a long-running write can then replay its answer.