Skip to content

Add comprehensive documentation for Agent Run Logs API #1130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

codegen-sh[bot]
Copy link
Contributor

@codegen-sh codegen-sh bot commented Jun 10, 2025

Overview

This PR adds comprehensive documentation for the Agent Run Logs API endpoint (/agent/run/{agent_run_id}/logs) that returns AgentRunLog data. The endpoint is currently in ALPHA status and wasn't fully documented.

What's Added

📚 New Documentation Page: docs/api-reference/agent-run-logs.mdx

Complete field reference for AgentRunLogResponse:

  • agent_run_id, created_at, tool_name, message_type
  • thought, observation, tool_input, tool_output
  • Data types, descriptions, and when each field is populated

All AgentLogType enum values explained:

  • Plan Agent types: ACTION, PLAN_EVALUATION, FINAL_ANSWER, ERROR, USER_MESSAGE
  • PR Agent types: INITIAL_PR_GENERATION, DETECT_PR_ERRORS, FIX_PR_ERRORS
  • Commit Agent types: COMMIT_EVALUATION
  • Link types: AGENT_RUN_LINK

Practical usage examples:

  • Basic log retrieval and pagination
  • Filtering by log type
  • Debugging failed runs
  • Building monitoring dashboards

ALPHA status disclaimers and feedback channels

🧭 Updated Navigation: docs/docs.json

  • Added new "Guides" section under API Reference tab
  • Makes the documentation discoverable through main site navigation

Key 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 guide
  • docs/docs.json - Updated navigation structure

This 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 workAbout Codegen

- 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
@codegen-sh codegen-sh bot requested review from codegen-team and a team as code owners June 10, 2025 21:16
Copy link

codecov bot commented Jun 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor Author

codegen-sh bot commented Jun 10, 2025

Review request noted—I'll take a look! 🔍

💻 View my work

@jayhack jayhack merged commit 3761b6c into develop Jun 10, 2025
25 of 26 checks passed
@jayhack jayhack deleted the codegen-bot/add-agent-run-logs-documentation-1749590120 branch June 10, 2025 21:20
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.

1 participant