Update an Agent Config

patch

https://{protocol}://{base-url}/ai/api/v1/config/agent/{agent_config_id}

Update an Agent Config.

Path Params

agent_config_id

string

required

The ID of the Agent Config to use.

Body Params

Schema for updating an agent config.

name

length ≥ 2

The name of the agent.

description

The description of the agent.

prompt

length ≥ 2

The prompt for the agent.

llm_config_id

The ID of the LLM config associated with the agent.

llm_extra_config

OpenAIConfig | BedrockConfig | null

Extra configuration to pass to the LLM when instantiated.

Note: This will be validated against the LLM config's config_schema.

tool_config_ids

array | null

The IDs of the tool configs associated with the agent.

Must be provided if parameter_bindings are provided.

parameter_bindings

array | null

Explicit parameter bindings for each tool.

The order and length of this list must match tool_config_ids.
If provided, tool_config_ids must also be provided.

bound_tool_args

array | null

deprecated

DEPRECATED: Use parameter_bindings instead.

published_status

PublishedStatus | null

The published status of the agent.

mcp_server_config_ids

array | null

IDs of MCP server configs to assign to this agent.

Replaces all existing MCP server assignments.

input_json_schema

object | null

The input schema for the agent.

Specifies the inputs that the agents require conforming to the JSON schema
standard.
ref: https://json-schema.org/

Note that the actual recorded input_json_schema is a combination of this provided
schema and any parameters required by the tools based on parameter_bindings.

output_json_schema

object | null

The output schema for the agent.

Specifies the output that the agents output conforming to the JSON schema
standard.
ref: https://json-schema.org/

If None, the agent will output a string.

200Successful Response

401Authentication required. No valid session cookie or bearer token provided, or authentication failed.

404Resource not found. The detail field specifies which resource.

409Agent as tool name conflicts with an existing agent as tool name. Rename the agent and try again.

422Validation Error

500Internal server error during request processing.