feat: add checkpointing docs#692
Open
kausmeows wants to merge 2 commits into
Open
Conversation
ysolanky
reviewed
Jun 30, 2026
| description: HTTP endpoints for continuing, forking, branching, and inspecting runs. | ||
| --- | ||
|
|
||
| All run-control verbs ship as both SDK methods and HTTP endpoints. The HTTP layer is what AgentOS exposes for the FE; the SDK is what you call from your own Python code. |
Member
There was a problem hiding this comment.
Let's not use terms like FE for the docs. It should either be Control Plane or AgentOS.
ysolanky
reviewed
Jun 30, 2026
|
|
||
| The new session contains deep copies of every run. The original session is untouched. | ||
|
|
||
| ## Branch vs Fork |
Member
There was a problem hiding this comment.
I don't think this comparison is needed here. Though I see what you were trying to do, branching sessions and forking runs should not exist in the branch session page.
ysolanky
reviewed
Jun 30, 2026
|
|
||
| The integer form pairs naturally with checkpoint timeline entries. Indices returned by `GET /runs/{run_id}/checkpoints` are guaranteed pair-safe. | ||
|
|
||
| ## HTTP Equivalent |
Member
There was a problem hiding this comment.
Maybe this could just exist on the reference section of the docs instead of inside the run control docs.
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
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
add docs for checkpointing, regenerate, fork etc.
Type of Change
Related Issues/PRs (if applicable)
Checklist