RustyGPT API Documentation

Comprehensive API documentation for the RustyGPT project components.

Back to Main Documentation

API Reference

This section provides detailed API documentation for each component of the RustyGPT project. The documentation is automatically generated from the Rust source code using rustdoc.

Note: The API documentation will be automatically generated when the GitHub Pages workflow runs. This placeholder page will be replaced with links to the generated documentation.
Backend API

Documentation for the backend server components, including routes, handlers, and services.

Coming soon

Frontend API

Documentation for the frontend components, including UI components and state management.

Coming soon

Shared API

Documentation for shared models and utilities used by both frontend and backend.

Coming soon

HTTP API Endpoints

The RustyGPT backend exposes the following HTTP API endpoints:

Authentication

Endpoint Method Description
/api/oauth/github GET Initiate GitHub OAuth flow
/api/oauth/github/callback GET Handle GitHub OAuth callback
/api/oauth/github/manual POST Manual GitHub OAuth (for testing)
/api/oauth/apple GET Initiate Apple OAuth flow
/api/oauth/apple/callback GET Handle Apple OAuth callback
/api/oauth/apple/manual POST Manual Apple OAuth (for testing)

Protected Routes

Endpoint Method Description
/api/conversations GET Get all conversations for the authenticated user
/api/conversations/{conversation_id}/messages POST Send a message to a conversation
/api/stream/{user_id} GET Connect to the SSE stream for real-time message updates

Additional Resources

GitHub | MIT License

© 2025 RustyGPT Contributors