Skip to content

docs(api): document add_messages batch endpoint#2216

Closed
r266-tech wants to merge 2 commits into
volcengine:mainfrom
r266-tech:docs/add-messages-batch-api
Closed

docs(api): document add_messages batch endpoint#2216
r266-tech wants to merge 2 commits into
volcengine:mainfrom
r266-tech:docs/add-messages-batch-api

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

PR #2213 added POST /api/v1/sessions/{session_id}/messages/batch and the batch_add_messages() SDK method, but docs/{en,zh}/api/05-sessions.md only document add_message() (single). This adds a parallel add_messages() section (EN + ZH) covering the HTTP endpoint, Python SDK usage, parameters (100-message cap, same per-message fields as add_message()), and the added count in the response.

Source: #2213 (sponge225). Verified params/route/SDK signature against openviking/server/routers/sessions.py (BatchAddMessageRequest, batch_add_messages) and openviking_cli/client/{base,http,sync_http}.py.

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

2213 - Fully compliant

Compliant requirements:

  • Added add_messages() documentation to both EN/ZH docs
  • Included HTTP endpoint, SDK examples, parameters, response
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 100
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@r266-tech
Copy link
Copy Markdown
Contributor Author

Superseded by #2218, which was merged earlier today and added a full batch_add_messages() section to the same docs/{en,zh}/api/05-sessions.md files — documenting the identical POST /api/v1/sessions/{session_id}/messages/batch endpoint. Closing this as redundant since the endpoint is now documented on main. Thanks!

@r266-tech r266-tech closed this May 26, 2026
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project May 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant