Skip to content
This repository was archived by the owner on Feb 27, 2026. It is now read-only.

docs: rewrite Convos HTTP API reference#29

Draft
saulmc wants to merge 1 commit intostagingfrom
docs/convos-http-api-reference
Draft

docs: rewrite Convos HTTP API reference#29
saulmc wants to merge 1 commit intostagingfrom
docs/convos-http-api-reference

Conversation

@saulmc
Copy link
Copy Markdown
Member

@saulmc saulmc commented Feb 17, 2026

Summary

  • Rewrites extensions/convos/POOL-MANAGER.md as a factual HTTP API reference derived from the implemented code
  • Documents all 12 HTTP endpoints with exact request parameters, defaults, and response shapes
  • Adds missing endpoints: /convos/setup, /convos/setup/status, /convos/setup/complete, /convos/setup/cancel, /convos/reset
  • Adds missing parameters on /convos/conversation (profileName, profileImage, description, imageUrl, permissions, instructions) and /convos/join (profileName, profileImage, instructions)
  • Documents poolApiKey Bearer authentication
  • Removes hypothetical/recommended content (golden checkpoint proposal, provisioning walkthrough, customization guidance)

Test plan

  • Verify documented endpoints, params, and responses match extensions/convos/index.ts

@macroscopeapp
Copy link
Copy Markdown

macroscopeapp Bot commented Feb 17, 2026

Rewrite Convos plugin docs to provide HTTP API reference and authentication details in POOL-MANAGER.md

Replace the prior provisioning guide with an HTTP API reference covering Bearer auth via channels.convos.poolApiKey, status and conversation endpoints, setup/reset flows with 10-minute auto-cleanup, one-conversation-per-process 409 constraints, and request/response schemas with codes including 401, 409, and timeout behavior.

📍Where to Start

Start with the HTTP API sections in POOL-MANAGER.md, beginning at the authentication overview and GET /convos/status to follow endpoint semantics.


Macroscope summarized 96be0ac.

@saulmc saulmc marked this pull request as draft February 17, 2026 05:26
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant