Skip to content

feat: add checkpointing docs#692

Open
kausmeows wants to merge 2 commits into
mainfrom
feat/checkpointing
Open

feat: add checkpointing docs#692
kausmeows wants to merge 2 commits into
mainfrom
feat/checkpointing

Conversation

@kausmeows

Copy link
Copy Markdown
Contributor

Description

add docs for checkpointing, regenerate, fork etc.

Type of Change

  • Bug fix (errors, broken links, outdated info)
  • New content
  • Content improvement
  • Other: ____

Related Issues/PRs (if applicable)

  • Closes #____
  • Related SDK PR: agno-agi/agno#____

Checklist

  • Content is accurate and up-to-date
  • All links tested and working
  • Code examples verified (if applicable)
  • Spelling and grammar checked
  • Screenshots updated (if applicable)

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not use terms like FE for the docs. It should either be Control Plane or AgentOS.


The new session contains deep copies of every run. The original session is untouched.

## Branch vs Fork

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


The integer form pairs naturally with checkpoint timeline entries. Indices returned by `GET /runs/{run_id}/checkpoints` are guaranteed pair-safe.

## HTTP Equivalent

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this could just exist on the reference section of the docs instead of inside the run control docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants