ChatRunStatusResponse = { runId, status } to match the implemented endpoint (chat#1813)

[sweetmantech]

Follow-up to docs#249: reconcile the documented GET /api/chat/runs/{runId} response with the api implementation (api#704).

What

ChatRunStatusResponse → { runId, status } (dropped chatId / sessionId / startedAt / completedAt / error).

Why

The endpoint wraps the durable workflow's getRun(runId).status, which exposes only status. There is no durable runId → chat mapping today, and the caller already receives chatId / sessionId in the 202 start response — so echoing them on status is redundant. Returning { runId, status } is the cheap, correct "is it done?" contract.

A future chats.last_run_id column would let the status endpoint also return chatId/sessionId and enforce per-run ownership — a separate database+api follow-up if needed.

Verified

The status enum (queued | running | completed | failed | cancelled) is confirmed against real preview runs — observed running then completed end-to-end.

🤖 Generated with Claude Code

---

Summary by cubic

Aligned GET /api/chat/runs/{runId} docs with the implemented API: ChatRunStatusResponse now returns only { runId, status }.
Removed chatId, sessionId, startedAt, completedAt, and error; use the chatId from the 202 start response to fetch produced content.

^{Written for commit b820f93. Summary will update on new commits.}

[coderabbitai]

Warning

Review limit reached

@sweetmantech, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 4 minutes and 55 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 599972ac-2963-4172-9e49-14e1211aba91

📥 Commits

Reviewing files that changed from the base of the PR and between 58f442a and b820f93.

📒 Files selected for processing (1)

• api-reference/openapi/research.json

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/chat-run-status-shape

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[cubic-dev-ai]

No issues found across 1 file

_{Re-trigger cubic}

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
recoup-docs	🟢 Ready	View Preview	Jun 24, 2026, 7:58 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.