Skip to content

docs(user-guide): add conversation finishing api guide - #393

Open
bohdanmaliar wants to merge 1 commit into
codemie-ai:mainfrom
bohdanmaliar:docs/EPMCDME-11067-conversation-finishing
Open

docs(user-guide): add conversation finishing api guide#393
bohdanmaliar wants to merge 1 commit into
codemie-ai:mainfrom
bohdanmaliar:docs/EPMCDME-11067-conversation-finishing

Conversation

@bohdanmaliar

Copy link
Copy Markdown

Summary

Documents the shipped conversation finishing APIs so applications and schedulers can close chats that should no longer accept new messages.

Changes

  • Added the Finish Conversations API page (owner finish, admin bulk finish, admin list filters, finished_at on reads, HTTP 409)
  • Linked the page from the API index, Assistants hub, delete-chats note, glossary, and admin retention FAQ
  • Added FAQ entries for finishing a conversation and whether auto-close after N hours exists

Testing

  • Tested locally with npm start
  • All pages render correctly
  • Images display properly
  • Internal links work
  • Sidebar navigation works

Verified with npm run check and npm run build (broken-link throw). No new images.

Quality Checks

  • npm run check passes (typecheck + lint + commitlint)
  • No MDX compilation errors
  • No raw angle brackets (<text> must be `<text>`)
  • Sidebar references document IDs (not filenames)
  • Images stored locally next to content (not in static/img/)
  • Commit messages follow Conventional Commits
  • No secrets or credentials in documentation

Additional Notes

Ticket: EPMCDME-11067. There is no CodeMie UI control for finishing a chat; this is a platform API capability. Auto-expiry is not built in — an external scheduler can list unfinished conversations and call bulk finish.

Co-authored-by: Cursor <cursoragent@cursor.com>
@elluvium
elluvium force-pushed the docs/EPMCDME-11067-conversation-finishing branch from c9e4a15 to 97c5d75 Compare September 11, 2026 10:20
@github-actions

Copy link
Copy Markdown

PR Preview Ready!

Your preview documentation is ready! Visit it here:

Preview URL: http://codemie-docs-pr-previews.s3-website.eu-central-1.amazonaws.com/pr-393/

Note: This preview URL is accessible only while connected to the company VPN.


This preview will be automatically updated when you push new commits to this PR.
Preview files will be deleted when the PR is closed or merged.

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