Document conversation goal endpoints#581
Open
enyst wants to merge 1 commit into
Open
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Co-authored-by: openhands <openhands@all-hands.dev>
enyst
force-pushed
the
docs-goal-conversations
branch
from
bc9795d to
3eec120
Compare
enyst
changed the title
VascoSch92
approved these changes
Jun 18, 2026
VascoSch92
left a comment
VascoSch92
left a comment
Member
There was a problem hiding this comment.
LGTM!
PR for the core docs: #580
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
3 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.
This PR was created by an AI agent (OpenHands) on behalf of the user.
Summary
/api/conversations/{conversation_id}/goal,/goal/stop, and/goal/resumeendpoints.ConversationStateUpdateEvent(key="goal"), stops as resumableinterrupted, and resumes from the latest persisted goal status.Notes
This documents behavior introduced by OpenHands/software-agent-sdk#3770. Please merge this docs PR after that SDK PR lands or alongside the release that includes it.
I intentionally did not regenerate
llms.txt/llms-full.txtin this PR because the current generator produces broad unrelated drift; the scheduled sync workflow can refresh those context files separately.Validation
cd /tmp/software-agent-sdk-pr3770 && uv run pytest tests/agent_server/test_goal_loop.py tests/agent_server/test_conversation_router.py -q— 96 passed, verifying the referenced PR behavior without modifying it.cd /workspace/project/docs && npx -y mint@latest broken-links— passed (success no broken links found).cd /workspace/project/docs && python3 ...navigation-path check — passed (docs.json navigation paths exist).cd /workspace/project/docs && uv run --with pytest --with requests pytest -q tests/— failed before docs-specific assertions becauseyamlwas missing.cd /workspace/project/docs && uv run --with pytest --with requests --with pyyaml pytest -q tests/— 34 passed, 2 errors in existing pricing tests becausehttps://raw.githubusercontent.com/OpenHands/OpenHands/main/openhands/utils/llm.pyreturns 404.