docs(decisions): add high/low level api guidance#511
Merged
mkmeral merged 2 commits intostrands-agents:mainfrom Feb 2, 2026
Merged
docs(decisions): add high/low level api guidance#511mkmeral merged 2 commits intostrands-agents:mainfrom
mkmeral merged 2 commits intostrands-agents:mainfrom
Conversation
pgrayy
previously approved these changes
Jan 30, 2026
Contributor
Documentation Deployment CompleteYour documentation preview has been successfully deployed! Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-511/ |
zastrowm
previously approved these changes
Feb 2, 2026
Co-authored-by: Mackenzie Zastrow <3211021+zastrowm@users.noreply.github.com>
Contributor
Documentation Deployment CompleteYour documentation preview has been successfully deployed! Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-511/ |
zastrowm
approved these changes
Feb 2, 2026
pgrayy
approved these changes
Feb 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a new decision record documenting our approach to API design: providing both low-level and high-level APIs for new features.
This decision formalizes the pattern we've been following (e.g., in
BidiAgentwithsend/receivevsrun) and provides rationale grounded in our tenets. It references the progressive disclosure principle from UX design and the pit of success concept.This pattern is well-established in SDK design — AWS CDK uses similar "construct levels" (L1/L2/L3) where lower levels map directly to underlying resources while higher levels provide opinionated abstractions.
Related Issues
N/A
Type of Change
Checklist
mkdocs serveBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.