Choose an integration
Compare common integration approaches without assuming a platform-specific SDK or protocol.
Working scaffold: The options below are common patterns, not a claim that ONE currently provides every option. Publish only the paths that are tested and supported.
Common approaches
| Approach | Useful when | Confirm before recommending |
|---|---|---|
| Direct HTTP API | You want to make requests from any language with explicit control over the wire format | Supported endpoint, auth, request schema, streaming protocol, and error format |
| Maintained client library | You want typed helpers for requests and responses | Official package names, supported languages, versioning, and feature coverage |
| Compatible client | You already use a client that speaks a compatible protocol | Exact compatibility scope, unsupported options, and migration differences |
| Agent or orchestration framework | Your application needs multi-step execution, tool dispatch, or managed state | Whether ONE supports the framework directly or whether the application owns orchestration |
How to choose
Start with the smallest approach that satisfies the application's needs. A direct request is a useful baseline because it makes authentication, input, output, and errors visible. Add an SDK or framework only when it reduces meaningful work and its behavior is documented.
An SDK is not automatically interchangeable with a compatible API. Verify base URL configuration, request serialization, streaming, errors, and advanced options with an integration test before describing it as a drop-in replacement.
Suggested default
For a new integration, document one recommended path and keep alternatives brief. Link to a separate guide for each supported library instead of adding untested choices to the first-use walkthrough.