doctl genai agent update
Generated on 23 Jun 2025
from doctl version
v1.131.0
Usage
doctl genai agent update <agent-id> [flags]Aliases
uDescription
Use this command to update the name and configuration of an agent.
Example
The following example updates the name of an Agent with the ID 12345678-1234-1234-1234-123456789012 to new-name:
doctl genai agent update 12345678-1234-1234-1234-123456789012 --name "new-name"Flags
| Option | Description |
|---|---|
--Anthropic-key-id |
Anthropic Key ID |
--agent-id |
The ID of the agent to update |
--description |
Description of an agent |
--format |
Columns for output in a comma-separated list. Possible values: Id, Name, Region, Project-id, Model-id, CreatedAt, UserId. |
--help, -h |
Help for this command |
--instruction |
Agent instruction. Instructions help your agent to perform its job effectively. |
--k |
specifies how many results should be considered from an attached knowledge base Default: 0 |
--max-tokens |
Specifies the maximum number of tokens the model can process in a single input or output, set as a number between 1 and 512. This determines the length of each response. Default: 0 |
--model-id |
Model ID. Identifier for the foundation model. |
--name |
Agent name |
--no-header |
Return raw data with no headers Default: false |
--openai-key-id |
OpenAI API key ID to use with OpenAI models |
--project-id |
UUID of the project to assign the Agent to |
--region |
specifies the region to create an Agent in, such as tor1. Use the “doctl compute region list” command for a list of valid regions. |
--retrieval-method |
Specifies the method used to retrieve information. The options are ‘RETRIEVAL_METHOD_UNKNOWN’, ‘RETRIEVAL_METHOD_REWRITE’,‘RETRIEVAL_METHOD_STEP_BACK’,‘RETRIEVAL_METHOD_SUB_QUERIES’ and ‘RETRIEVAL_METHOD_NONE’. The default is ‘RETRIEVAL_METHOD_UNKNOWN’. |
--temperature |
Specifies the temperature of the model. The temperature is a number between 0 and 1 that determines how creative or random the model’s responses are. A lower temperature results in more predictable responses, while a higher temperature results in more creative responses. Default: 0 |
--top-p |
the cumulative probability threshold for word selection, specified as a number between 0 and 1. Higher values allow for more diverse outputs, while lower values ensure focused and coherent responses. Default: 0 |
Related Commands
| Command | Description |
|---|---|
| doctl genai agent | Display commands for working with GenAI agents |
Global Flags
| Option | Description |
|---|---|
--access-token, -t |
API V2 access token |
--api-url, -u |
Override default API endpoint |
--config, -c |
Specify a custom config file Default: |
--context |
Specify a custom authentication context name |
--http-retry-max |
Set maximum number of retries for requests that fail with a 429 or 500-level error
Default: 5 |
--http-retry-wait-max |
Set the minimum number of seconds to wait before retrying a failed request
Default: 30 |
--http-retry-wait-min |
Set the maximum number of seconds to wait before retrying a failed request
Default: 1 |
--interactive |
Enable interactive behavior. Defaults to true if the terminal supports it (default false)
Default: false |
--output, -o |
Desired output format [text|json] Default: text |
--trace |
Show a log of network activity while performing a command Default: false |
--verbose, -v |
Enable verbose output Default: false |