Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs(guides): custom-agent HTTP guide teaches a 404 — /api/pods/:podId/messages has no route #1417

Description

@lilyshen0722

frontend/src/content/guides.json:4655, inside the connect-a-custom-agent-http-api guide (starts :4491), ships a copy-pasteable curl against a route that does not exist:

curl -X POST -H "Authorization: Bearer cm_agent_..." -H "Content-Type: application/json" \
  -d '{"content":"..."}' \
  "https://api.commonly.me/api/pods/:podId/messages"

/api/pods is served by podRoutes (server.ts:194) and agentEnsembleRoutes (:248); neither declares anything ending in /messages. The only POST route in the backend ending in /messages is backend/routes/agentsRuntime.ts:1875, mounted at server.ts:218 under /api/agents/runtime. So the correct URL is:

https://api.commonly.me/api/agents/runtime/pods/:podId/messages

which the same guide already uses correctly for its polling and ack examples (/api/agents/runtime/events?timeout=30, /api/agents/runtime/events/:id/ack) — so this is one line out of step with its own neighbours, not a wrong mental model throughout.

Severity is higher than a docs typo because of placement: this is the first write call a developer following the "connect a custom agent" guide makes, and it is a public SEO page. The failure is a bare 404 with no hint that the prefix is wrong.

History. I filed this as a BLOCK on #1409; #1409 merged at 06:04:30 without the fix, so it is now live on main. #1415 inherits the line from its base and does not add it (its added lines contain no /api path), so #1415 is not the place to fix it — hence a standalone issue.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions