fix(docs): update custom-agent docs to use required 'name' field - #4969
Open
Battleplus wants to merge 3 commits into
Open
fix(docs): update custom-agent docs to use required 'name' field#4969Battleplus wants to merge 3 commits into
Battleplus wants to merge 3 commits into
Conversation
The custom-agent docs described a 'display_name' field and an auto-derived slug, but POST /api/agents requires callers to provide 'name'. Updated all 4 affected pages (en/zh) to match the actual AgentCreateRequest contract. Closes bytedance#4942
github-actions
Bot
added
area:docs
willem-bd
reviewed
Aug 25, 2026
willem-bd
left a comment
willem-bd
left a comment
Contributor
There was a problem hiding this comment.
One remaining documentation inconsistency leaves the reported display_name contract issue partially unresolved.
Contributor
Author
|
Fixed. Updated the capabilities bullet at line 22 to remove the auto-derived slug claim: -- a **display name** and an auto-derived ASCII slug (the `name` used internally)
+- a **name** (caller-provided unique slug identifier) and an optional **display name** for the UIThis accurately reflects that |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
The custom-agent docs describe a
display_namefield and an auto-derived slug, butPOST /api/agentsrequires callers to providename. The documented Chinese payload is rejected with a 422 validation error.Changes
Updated 4 affected pages (en/zh) to match the actual
AgentCreateRequestcontract:frontend/src/content/en/application/agents-and-threads.mdx: Replaceddisplay_nameslug description withnamefield requirement; removeddisplay_namefrom YAML example.frontend/src/content/zh/application/agents-and-threads.mdx: Fixed curl example to usename; replaced slug/auto-derive explanation withnamefield requirement.frontend/src/content/en/harness/lead-agent.mdx: Removed staledisplay_namereferences from Lead Agent docs.frontend/src/content/zh/harness/lead-agent.mdx: Removed staledisplay_namereferences from Lead Agent docs (Chinese).