Reference
The Commitscale API.
Request and response schemas, examples and problem codes, from the server you call.
Download OpenAPI 3.1 ↗API reference
Choose an operation for its parameters, request, response and problem codes. The reference follows the features included by Free or Pro on this server. Each operation also explains who may call it.
Test checks
- GET Read the server's acceptance public key
/api/v1/tests/acceptance-key - GET Read whether your test acceptances need a passkey
/api/v1/tests/acceptance-policy - POST Ask to sign your test acceptance with a passkey
/api/v1/tests/acceptances - GET Read your test acceptance
/api/v1/tests/acceptances/{id} - POST Start a local test check's model questions
/api/v1/tests/checks - POST Ask one of the local check's five model questions
/api/v1/tests/checks/{check_id}/questions
Accounts & authentication
- GET Discover the authorization server
/.well-known/oauth-authorization-server - GET Discover the MCP resource
/.well-known/oauth-protected-resource/mcp - GET Your account's name and sign-in email
/api/v1/account - DELETE Withdraw data sharing and delete excerpts
/api/v1/account/data-sharing - GET Read your data-sharing choice
/api/v1/account/data-sharing - PUT Choose whether to share check data
/api/v1/account/data-sharing - GET Read your optional passkey layer
/api/v1/account/passkey-layer - PUT Change your optional passkey layer
/api/v1/account/passkey-layer - POST Start a person's login
/api/v1/auth/device - POST Approve or deny a terminal's login
/api/v1/auth/device/code - POST Poll for a person's token
/api/v1/auth/device/token - POST Email a sign-in link
/api/v1/auth/email-link - GET The caller's linked accounts
/api/v1/auth/identities - DELETE Unlink an account at a provider
/api/v1/auth/identities/{id} - POST Accept an invite from an email link
/api/v1/auth/invites/accept - POST What an invite's link does
/api/v1/auth/invites/check - POST Revoke the token in use
/api/v1/auth/logout - GET How people can sign in here
/api/v1/auth/methods - POST Start signing in with a passkey
/api/v1/auth/passkey/challenge - POST Sign in with a passkey
/api/v1/auth/passkey/session - GET The caller's passkeys
/api/v1/auth/passkeys - POST Start adding a passkey
/api/v1/auth/passkeys - POST Finish adding a passkey
/api/v1/auth/passkeys/finish - DELETE Remove a passkey
/api/v1/auth/passkeys/{id} - POST Start linking an account at a provider
/api/v1/auth/providers/{provider}/link - POST Start signing in with a provider
/api/v1/auth/providers/{provider}/start - POST Email yourself a link to sign in again
/api/v1/auth/sign-in-again - POST Start sign-up for a person and their agent
/api/v1/auth/signup - POST Preview an emailed sign-up without verifying it
/api/v1/auth/signup/check - POST Collect the agent's check-only key once
/api/v1/auth/signup/key - POST Verify the email and create the person's account
/api/v1/auth/signup/verify - POST What a one-time link does
/api/v1/auth/tickets/check - POST Use a one-time link
/api/v1/auth/tickets/redeem - GET List your CLI logins and browser sessions
/api/v1/auth/tokens - POST Sign out everywhere else
/api/v1/auth/tokens/revoke-others - DELETE Revoke one of your CLI logins or browser sessions
/api/v1/auth/tokens/{id} - POST A one-time sign-in link for a browser
/api/v1/auth/web-link - POST Which account a sign-in link is for
/api/v1/auth/web-link/check - POST Exchange a sign-in link for a session
/api/v1/auth/web-session - GET List your agents' check-only keys
/api/v1/check-keys - POST Give another agent a check-only key
/api/v1/check-keys - POST Create a check key with your passkey
/api/v1/check-keys/confirmed - GET Read this check-only key's own usage
/api/v1/check-keys/current/usage - DELETE Revoke one of your check-only keys
/api/v1/check-keys/{id} - PUT Name one of your check-only keys
/api/v1/check-keys/{id} - GET List your connected apps
/api/v1/oauth/grants - DELETE Revoke a connected app
/api/v1/oauth/grants/{id} - GET Who the caller is
/api/v1/whoami - GET Start an OAuth authorization
/oauth/authorize - POST Register a public OAuth client
/oauth/register - POST Revoke an OAuth token
/oauth/revoke - POST Exchange or refresh an OAuth token
/oauth/token
Plans & billing
- GET Your personal Pro subscription
/api/v1/billing - POST Buy Pro for yourself
/api/v1/billing/checkout - POST Open the buyer's customer portal
/api/v1/billing/portal - POST Resolve an unfinished purchase
/api/v1/billing/requests/resolve - GET Read an organization's Pro subscription
/api/v1/orgs/{org}/billing - POST Start Pro for an organization's members
/api/v1/orgs/{org}/billing/checkout - POST Resume an organization's pending checkout
/api/v1/orgs/{org}/billing/checkout/resolve - POST Manage an organization's subscription
/api/v1/orgs/{org}/billing/portal - GET Read an organization's plan and seats
/api/v1/orgs/{org}/billing/summary
invites
- GET Invites that wait
/api/v1/invites - POST Invite someone by email
/api/v1/invites - GET Invites that wait for you
/api/v1/invites/mine - DELETE Withdraw an invite
/api/v1/invites/{id} - POST Accept your organization invite
/api/v1/invites/{id}/accept - POST Decline an invite
/api/v1/invites/{id}/decline
Organizations & usage
- GET The namespace's plan and feature flags
/api/v1/namespaces/{ns}/plan - GET What a namespace used, day by day
/api/v1/namespaces/{ns}/usage - GET The caller's organizations
/api/v1/orgs - POST Create an organization
/api/v1/orgs - GET An organization
/api/v1/orgs/{org} - GET An organization's members
/api/v1/orgs/{org}/members - DELETE Remove a member
/api/v1/orgs/{org}/members/{user} - PUT Invite a person, or change a member's role
/api/v1/orgs/{org}/members/{user}
API descriptions
- GET The public API description
/api/v1/openapi/public.json - POST Call the remote MCP server
/mcp - GET Discover the remote MCP server
/mcp/server-card