docs: fix API documentation examples for messages endpoints #2822
+36
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add proper examples to streaming and non-streaming message endpoints that include the required 'type' field in content objects. Previously, the auto-generated examples were missing this discriminator field, causing validation errors when users tried the curl commands.
Updated endpoints:
- /v1/agents/{agent_id}/messages (POST)
- /v1/agents/{agent_id}/messages/stream (POST)
- /v1/groups/{group_id}/messages (POST)
- /v1/groups/{group_id}/messages/stream (POST)
All examples now show content as an array of objects with proper type discrimination rather than plain strings.
cpacker
approved these changes
Sep 10, 2025
github-project-automation
bot
moved this from To triage
to Done
in 🐛 MemGPT issue tracker
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Snippets properly contain type/content fields:
Problem
The auto-generated API documentation examples were missing the required
type: "text"discriminator field in message content objects. This caused validation errors when users tried the curl commands from the docs, as reported in Discord.Solution
Added proper
requestBodyexamples to the fern openapi-overrides.yml file for:/v1/agents/{agent_id}/messages(POST)/v1/agents/{agent_id}/messages/stream(POST)/v1/groups/{group_id}/messages(POST)/v1/groups/{group_id}/messages/stream(POST)All examples now show:
contentas an array of objects (not string)type: "text"field for proper union type discrimination