API Reference
Use this page to choose the fastest way to integrate ROAM into your product. Whether you are embedding ROAM into an application, automating workflows, or standardizing service-to-service communication, the references below point to the public surfaces intended for real adoption.
Client SDKs
Choose the SDK that best matches your application stack.
Build Python applications and automation flows that integrate ROAM with a lightweight, script-friendly client surface.
Integrate ROAM into .NET services and enterprise applications with a familiar typed client experience.
Use the core Rust crate when you want maximum control, native performance, or direct access to the public runtime model.
Shared Contract
When you need a language-neutral integration surface, start with the protocol definitions.
Protobuf Definitions
Review the public gRPC contract, message shapes, and service definitions that keep multi-language integrations aligned.
HTTP REST API
The Rocket HTTP backend exposes a live, interactive API reference via Swagger UI. Use it to explore endpoints, inspect request/response schemas, and try calls directly from the browser.
Browse all route schemas, try requests live, and inspect request/response bodies.
Requires the backend to be running (make http-start).
OpenAPI JSON: http://localhost:8000/api/openapi.json
Suggested Starting Points
- Building application logic in Python: start with the Python SDK.
- Shipping a service or platform integration on .NET: start with the .NET SDK.
- Building custom runtimes or native integrations: start with the Rust client crate.
- Aligning multiple clients or generating your own bindings: start with the protobuf definitions.
- Exploring or testing HTTP endpoints interactively: start with the Swagger UI.