Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.protean.peerislands.io/llms.txt

Use this file to discover all available pages before exploring further.

The API is Hono on Bun. OpenAPI 3.1 derived from Zod schemas — see ADR-0006. The committed snapshot lives at apps/api/openapi.json. CI fails the build if the snapshot is out of date.

Endpoints (M0)

MethodPathPurpose
GET/v1/healthLiveness + version + uptime + dep status.
GET/v1/auth/login/{provider}Begin an OAuth flow. Provider: google, github, o365. Returns { authorizationUrl }; sets state + PKCE cookies.
GET/v1/auth/callback/{provider}Provider redirects here with code + state. Exchanges, mints session JWT, sets protean_session cookie.
GET/v1/auth/meReturns claims of the current session, or 401.
GET/v1/openapi.jsonLive OpenAPI doc, derived from Zod at request time.
Slice 1 will add /v1/agents/company-research/runs and /v1/runs/{id}/events (SSE).

Embedding

Once Mintlify is configured, the OpenAPI spec auto-renders into navigable reference pages via mint.json’s openapi setting. For now this page links to the raw JSON.