> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/powershell-universal/powershell-commands/set-psuaiagent.md). # Set-PSUAiAgent ## SYNOPSIS Updates an existing AI agent definition. ## SYNTAX ### Id ``` Set-PSUAiAgent [-Id] [-Name ] [-Description ] [-Instructions ] [-Model ] [-ApiKey ] [-Tool ] [-ComputerName ] [-AppToken ] [-Credential ] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies] [] ``` ### AiAgent ``` Set-PSUAiAgent [-AiAgent] [-Name ] [-Description ] [-Instructions ] [-Model ] [-ApiKey ] [-Tool ] [-ComputerName ] [-AppToken ] [-Credential ] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies] [] ``` ## DESCRIPTION Loads an AI agent by Id or pipeline object and updates only the fields supplied to the cmdlet. This lets you make partial changes without rebuilding the entire agent definition. ## EXAMPLES ### Example 1 ```powershell PS C:\> Set-PSUAiAgent -Id 12 -Instructions "Escalate billing issues to humans." -Tool GetInvoices,CreateTicket ``` Updates agent 12 with new instructions and replaces its tool list. ## PARAMETERS ### -AiAgent Specifies the AI agent to target. ```yaml Type: AiAgent Parameter Sets: AiAgent Aliases: Required: True Position: 0 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -ApiKey Specifies the PSU variable that contains the API key used by the AI agent. ```yaml Type: Variable Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -AppToken Specifies the app token to use when authenticating to the PowerShell Universal management API. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ComputerName Specifies the URL or host name of the target PowerShell Universal instance. Bare host names are normalized to an http\://:5000 URL. ```yaml Type: String Parameter Sets: (All) Aliases: Uri Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Cookies Reuses and persists authentication cookies for the current PowerShell session. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Credential Specifies the credentials to use for Basic authentication against the PowerShell Universal management API. ```yaml Type: PSCredential Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Description Specifies a description for the resource. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Id Specifies the numeric Id of the resource. ```yaml Type: Int64 Parameter Sets: Id Aliases: Required: True Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Instructions Specifies the system instructions or operating guidance the AI agent follows when generating responses. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Integrated Uses the in-process integrated management client when the cmdlet runs inside PowerShell Universal. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Model Specifies the AI model identifier the agent should use for completions. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Name Specifies the name of the resource. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Tool Specifies the names of the AI tools the agent can use. ```yaml Type: String[] Parameter Sets: (All) Aliases: Tools Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -TrustCertificate Allows connections to servers with untrusted TLS certificates. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -UseDefaultCredentials Uses the current Windows credentials when authenticating to the management API. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see [about\_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### PowerShellUniversal.Models.Intelligence.AiAgent ## OUTPUTS ### System.Object ## NOTES ## RELATED LINKS --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.devolutions.net/powershell-universal/powershell-commands/set-psuaiagent.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.