docloom.

API documentation

Babarkhan01/Docloom

branch main · published September 22, 2026

Babarkhan01/Docloom — API Reference

Structural facts below were extracted from the source at branch main with a TypeScript AST parser; descriptions are AI-written from those facts only.

Endpoints (4)

MethodPathDescription
GET/api/auth/github/callbackHandles the GitHub OAuth redirect by exchanging the authorization code server-side, upserting the user, and issuing a signed session cookie.
GET/api/auth/githubInitiates the GitHub App OAuth authorization code flow to obtain a user-to-server token.
POST/api/repos/[id]/generateStarts a documentation generation run for the specified repo owned by the caller, enforcing the free-plan daily generation cap.
GET/api/repos/availableReturns the repositories accessible to the user via the GitHub App that are not yet connected, using a read-only user-to-server token.

Reference

/api/auth/github/callback

GET /api/auth/github/callback

Handles the GitHub OAuth redirect by exchanging the authorization code server-side, upserting the user, and issuing a signed session cookie.

Details

/api/auth/github

GET /api/auth/github

Initiates the GitHub App OAuth authorization code flow to obtain a user-to-server token.

Details

/api/repos/[id]/generate

POST /api/repos/[id]/generate

Starts a documentation generation run for the specified repo owned by the caller, enforcing the free-plan daily generation cap.

Details

/api/repos/available

GET /api/repos/available

Returns the repositories accessible to the user via the GitHub App that are not yet connected, using a read-only user-to-server token.

Details