Skip to main content
Microsoft Foundry
Start building
View as Markdown
View as Markdown
Agents

Update an agent endpoint

PATCH
/agents/{agent_name}

Applies a merge-patch update to the specified agent endpoint configuration.

Path Parameters
agent_namestringrequired
The name of the agent to retrieve.
Query Parameters
api-versionstringrequired
The API version to use for this operation.
Header Parameters
Foundry-Featuresstringoptional
A feature flag opt-in required when using preview operations or modifying persisted preview resources.
AgentEndpoints=V1Preview
Request BodyContent-Type: application/merge-patch+json
agent_endpointAgentEndpointConfigUpdate
The endpoint configuration for the agent
version_selectorVersionSelectorUpdate
The version selector of the agent endpoint determines how traffic is routed to different versions of the agent.
protocolsenum[]
The protocols that the agent supports
activityresponsesa2amcpinvocationsinvocations_ws
authorization_schemes(Entra | BotService | BotServiceRbac)[]
The authorization schemes supported by the agent endpoint
agent_cardAgentCardUpdate
Optional agent card for the agent
versionstring
The version of the agent card.
descriptionstring
The description of the agent card.
skillsAgentCardSkill[]
The set of skills that an agent can perform.
Responses
objectenumrequired
The object type, which is always 'agent'.
agent
idstringrequired
The unique identifier of the agent.
namestringrequired
The name of the agent.
versionsobjectrequired
The latest version of the agent.
latestAgentVersionObjectrequired
agent_endpointAgentEndpointConfig
The endpoint configuration for the agent
version_selectorVersionSelector
The version selector of the agent endpoint determines how traffic is routed to different versions of the agent.
protocolsenum[]
The protocols that the agent supports
activityresponsesa2amcpinvocationsinvocations_ws
authorization_schemes(Entra | BotService | BotServiceRbac)[]
The authorization schemes supported by the agent endpoint
instance_identityAgentIdentity
The instance identity of the agent
principal_idstringrequired
The principal ID of the agent instance
client_idstringrequired
The client ID of the agent instance. Also referred to as the instance ID
blueprintAgentIdentity
The blueprint for the agent
principal_idstringrequired
The principal ID of the agent instance
client_idstringrequired
The client ID of the agent instance. Also referred to as the instance ID
blueprint_referenceManagedAgentIdentityBlueprint
The blueprint for the agent
One of the following:
ManagedAgentIdentityBlueprintManagedAgentIdentityBlueprintReference
agent_cardAgentCard
versionstringrequired
The version of the agent card.
descriptionstring
The description of the agent card.
skillsAgentCardSkill[]required
The set of skills that an agent can perform.