YaqeenDocs
Back to Yaqeen

Reference

Sign-in and health endpoints

The few addresses that are not in the API reference: the OAuth sign-in for AI clients, its discovery documents and the health check.

The API reference lists every address under /api/v1/ that returns JSON for the dashboard and for your code. These addresses are different. A person or an AI client uses them to sign in, or a monitor uses them to see that the server is up. They follow the OAuth and discovery standards, so they are described here and not in the generated reference.

Discovery#

Both answer GET with JSON and need no sign-in.

AddressWhat it says
/.well-known/oauth-authorization-serverWhere to sign in, where to get a token, where to register, and the methods supported.
/.well-known/oauth-protected-resourceWhich address is protected (the MCP address) and which server issues tokens for it.

The protected-resource document is also served at /.well-known/oauth-protected-resource/api/v1/mcp, with and without a trailing slash, because some clients ask for it by the resource path.

Sign-in for AI clients#

AddressMethodUse
/api/v1/oauth/authorize/GET, POSTThe sign-in and Allow page. A person uses it in a browser. Staff accounts only.
/api/v1/oauth/token/POSTTrades a code or a refresh token for an access token.
/api/v1/oauth/register/POSTLets a client register itself and declare its redirect addresses.
/api/v1/oauth/revoke/POSTRevokes a token.

PKCE with S256 is required. An access token lasts one hour and works at the MCP address only. How the flow looks from the user's side is in Connect Claude and Codex.

MCP#

POST /api/v1/mcp/ speaks JSON-RPC and is where an AI client calls the MCP tools. The address without the trailing slash, /api/v1/mcp, answers the same way. GET and PUT /api/v1/mcp/settings/ read and change the organisation's switch and redaction setting, and are in the API reference.

Health#

GET /healthz answers {"status": "ok"} when the server can reach its database, and fails when it cannot. It needs no sign-in and returns nothing about your data. For a fuller picture after you are signed in, use GET /api/v1/ops/health/, described in the go-live checklist.

Up Down to moveEnter to openEsc to close