docs: clarify :agent and :name parameters in API server endpoints#2213
Merged
dgageot merged 1 commit intodocker:mainfrom Mar 22, 2026
Merged
Conversation
Document that :agent is the config filename without the .yaml extension and :name is the optional sub-agent name (defaults to root). Add concrete examples for single-agent and multi-agent configurations. Fixes docker#2074 Assisted-By: docker-agent
![docker-agent[bot]](https://avatars.githubusercontent.com/in/2787757?s=60&v=4){kind=small}
rumpl
approved these changes
Mar 22, 2026
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.
Clarify the API server documentation for the agent execution endpoints.
:agentis the config filename without the.yamlextension:nameis the optional sub-agent name (defaults toroot)Fixes #2074