REST API Reference
The machine-readable contract lives in
openapi.yaml. A CI drift gate (openapi-sync-check) fails any PR that adds, renames, or removes a route inMakalu/api/src/{routes,litho}.tswithout a matching update there. Use the YAML when generating clients or running Postman/Insomnia against the API; treat this page as the prose tour.
Overview
The Lithosphere REST API provides HTTP endpoints for interacting with the Lithosphere network. The API returns JSON responses and follows standard REST conventions.
Base URL
The base URL is configurable via the LITHO_RPC_URL environment variable.
LITHO_RPC_URL=https://your-node-url.example.comAuthentication
Authentication details are to be determined. This section will be updated once the authentication mechanism is finalized.
Endpoints
GET /health
Health check endpoint. Returns the current status of the node.
Request:
curl -X GET ${LITHO_RPC_URL}/healthResponse (200 OK):
GET /api/litho
Returns chain information for the Lithosphere network.
Request:
Response (200 OK):
Response Format
All responses are returned in JSON format with appropriate Content-Type: application/json headers.
Status Codes
200
OK -- The request was successful.
400
Bad Request -- The request was malformed or missing required parameters.
401
Unauthorized -- Authentication failed or was not provided.
500
Internal Server Error -- An unexpected error occurred on the server.
Rate Limiting
Rate limiting details are to be determined. This section will be updated once rate limiting policies are implemented.
Further Reading
Full API documentation is coming soon. Check back for comprehensive endpoint references, request/response schemas, and integration guides.
Last updated