Add comprehensive documentation for Agent Run Logs API #1130
Conversation
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
- Create detailed API reference for /agent/run/{agent_run_id}/logs endpoint
- Document all AgentRunLogResponse fields with descriptions and examples
- Explain all AgentLogType enum values and their meanings
- Include practical usage examples for common scenarios
- Add ALPHA status disclaimers and feedback channels
- Update docs.json navigation to include new guide
Codecov ReportAll modified and coverable lines are covered by tests ✅ ✅ All tests successful. No failed tests found. 🚀 New features to boost your workflow:
|
jayhack
approved these changes
Jun 10, 2025
Contributor
Author
|
Review request noted—I'll take a look! 🔍 |
jayhack
deleted the
codegen-bot/add-agent-run-logs-documentation-1749590120
branch
Contributor
|
🎉 This PR is included in version 0.56.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
Overview
This PR adds comprehensive documentation for the Agent Run Logs API endpoint (
/agent/run/{agent_run_id}/logs) that returnsAgentRunLogdata. The endpoint is currently in ALPHA status and wasn't fully documented.What's Added
📚 New Documentation Page:
docs/api-reference/agent-run-logs.mdxComplete field reference for
AgentRunLogResponse:agent_run_id,created_at,tool_name,message_typethought,observation,tool_input,tool_outputAll
AgentLogTypeenum values explained:ACTION,PLAN_EVALUATION,FINAL_ANSWER,ERROR,USER_MESSAGEINITIAL_PR_GENERATION,DETECT_PR_ERRORS,FIX_PR_ERRORSCOMMIT_EVALUATIONAGENT_RUN_LINKPractical usage examples:
ALPHA status disclaimers and feedback channels
🧭 Updated Navigation:
docs/docs.jsonKey Features
✅ Field-by-field reference - Developers know exactly what each field contains
✅ Log type explanations - Clear understanding of different message types
✅ Real-world examples - Practical code snippets for common use cases
✅ ALPHA disclaimers - Appropriate warnings about endpoint stability
✅ Feedback channels - Clear paths for users to provide input
Files Changed
docs/api-reference/agent-run-logs.mdx- New comprehensive API guidedocs/docs.json- Updated navigation structureThis addresses the need for detailed field explanations that developers require when working with agent run logs, going beyond the basic auto-generated OpenAPI documentation.
💻 View my work • About Codegen