{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/UpdateAgent", "title": "UpdateAgent", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The name of the agent." }, "tool_ids": { "anyOf": [ { "items": { "type": "string", "maxLength": 41, "minLength": 41, "pattern": "^tool-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "description": "The ID of the tool in the format 'tool-'", "examples": [ "tool-123e4567-e89b-42d3-8456-426614174000" ] }, "type": "array" }, { "type": "null" } ], "title": "Tool Ids", "description": "The ids of the tools used by the agent." }, "source_ids": { "anyOf": [ { "items": { "type": "string", "maxLength": 43, "minLength": 43, "pattern": "^source-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "description": "The ID of the source in the format 'source-'", "examples": [ "source-123e4567-e89b-42d3-8456-426614174000" ] }, "type": "array" }, { "type": "null" } ], "title": "Source Ids", "description": "Deprecated: Use `folder_ids` field instead. The ids of the sources used by the agent.", "deprecated": true }, "folder_ids": { "anyOf": [ { "items": { "type": "string", "maxLength": 43, "minLength": 43, "pattern": "^source-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "description": "The ID of the source in the format 'source-'", "examples": [ "source-123e4567-e89b-42d3-8456-426614174000" ] }, "type": "array" }, { "type": "null" } ], "title": "Folder Ids", "description": "The ids of the folders used by the agent." }, "block_ids": { "anyOf": [ { "items": { "type": "string", "maxLength": 42, "minLength": 42, "pattern": "^block-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "description": "The ID of the block in the format 'block-'", "examples": [ "block-123e4567-e89b-42d3-8456-426614174000" ] }, "type": "array" }, { "type": "null" } ], "title": "Block Ids", "description": "The ids of the blocks used by the agent." }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "The tags associated with the agent." }, "system": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System", "description": "The system prompt used by the agent." }, "tool_rules": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/ChildToolRule" }, { "$ref": "#/components/schemas/InitToolRule" }, { "$ref": "#/components/schemas/TerminalToolRule" }, { "$ref": "#/components/schemas/ConditionalToolRule" }, { "$ref": "#/components/schemas/ContinueToolRule" }, { "$ref": "#/components/schemas/RequiredBeforeExitToolRule" }, { "$ref": "#/components/schemas/MaxCountPerStepToolRule" }, { "$ref": "#/components/schemas/ParentToolRule" }, { "$ref": "#/components/schemas/RequiresApprovalToolRule" } ], "discriminator": { "propertyName": "type", "mapping": { "conditional": "#/components/schemas/ConditionalToolRule", "constrain_child_tools": "#/components/schemas/ChildToolRule", "continue_loop": "#/components/schemas/ContinueToolRule", "exit_loop": "#/components/schemas/TerminalToolRule", "max_count_per_step": "#/components/schemas/MaxCountPerStepToolRule", "parent_last_tool": "#/components/schemas/ParentToolRule", "required_before_exit": "#/components/schemas/RequiredBeforeExitToolRule", "requires_approval": "#/components/schemas/RequiresApprovalToolRule", "run_first": "#/components/schemas/InitToolRule" } } }, "type": "array" }, { "type": "null" } ], "title": "Tool Rules", "description": "The tool rules governing the agent." }, "message_ids": { "anyOf": [ { "items": { "type": "string", "maxLength": 44, "minLength": 44, "pattern": "^message-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "description": "The ID of the message in the format 'message-'", "examples": [ "message-123e4567-e89b-42d3-8456-426614174000" ] }, "type": "array" }, { "type": "null" } ], "title": "Message Ids", "description": "The ids of the messages in the agent's in-context memory." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The description of the agent." }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "The metadata of the agent." }, "tool_exec_environment_variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Tool Exec Environment Variables", "description": "Deprecated: use `secrets` field instead" }, "secrets": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Secrets", "description": "The environment variables for tool execution specific to this agent." }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id", "description": "The id of the project the agent belongs to." }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id", "description": "The id of the template the agent belongs to." }, "base_template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Base Template Id", "description": "The base template id of the agent." }, "identity_ids": { "anyOf": [ { "items": { "type": "string", "maxLength": 45, "minLength": 45, "pattern": "^identity-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "description": "The ID of the identity in the format 'identity-'", "examples": [ "identity-123e4567-e89b-42d3-8456-426614174000" ] }, "type": "array" }, { "type": "null" } ], "title": "Identity Ids", "description": "The ids of the identities associated with this agent." }, "message_buffer_autoclear": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Message Buffer Autoclear", "description": "If set to True, the agent will not remember previous messages (though the agent will still retain state via core memory blocks and archival/recall memory). Not recommended unless you have an advanced use case." }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "The model handle used by the agent (format: provider/model-name)." }, "embedding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embedding", "description": "The embedding model handle used by the agent (format: provider/model-name)." }, "model_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/OpenAIModelSettings" }, { "$ref": "#/components/schemas/SGLangModelSettings" }, { "$ref": "#/components/schemas/AnthropicModelSettings" }, { "$ref": "#/components/schemas/GoogleAIModelSettings" }, { "$ref": "#/components/schemas/GoogleVertexModelSettings" }, { "$ref": "#/components/schemas/AzureModelSettings" }, { "$ref": "#/components/schemas/XAIModelSettings" }, { "$ref": "#/components/schemas/ZAIModelSettings" }, { "$ref": "#/components/schemas/GroqModelSettings" }, { "$ref": "#/components/schemas/DeepseekModelSettings" }, { "$ref": "#/components/schemas/TogetherModelSettings" }, { "$ref": "#/components/schemas/BedrockModelSettings" }, { "$ref": "#/components/schemas/BasetenModelSettings" }, { "$ref": "#/components/schemas/OpenRouterModelSettings" }, { "$ref": "#/components/schemas/ChatGPTOAuthModelSettings" } ], "discriminator": { "propertyName": "provider_type", "mapping": { "anthropic": "#/components/schemas/AnthropicModelSettings", "azure": "#/components/schemas/AzureModelSettings", "baseten": "#/components/schemas/BasetenModelSettings", "bedrock": "#/components/schemas/BedrockModelSettings", "chatgpt_oauth": "#/components/schemas/ChatGPTOAuthModelSettings", "deepseek": "#/components/schemas/DeepseekModelSettings", "google_ai": "#/components/schemas/GoogleAIModelSettings", "google_vertex": "#/components/schemas/GoogleVertexModelSettings", "groq": "#/components/schemas/GroqModelSettings", "openai": "#/components/schemas/OpenAIModelSettings", "openrouter": "#/components/schemas/OpenRouterModelSettings", "sglang": "#/components/schemas/SGLangModelSettings", "together": "#/components/schemas/TogetherModelSettings", "xai": "#/components/schemas/XAIModelSettings", "zai": "#/components/schemas/ZAIModelSettings" } } }, { "type": "null" } ], "title": "Model Settings", "description": "The model settings for the agent." }, "compaction_settings": { "anyOf": [ { "$ref": "#/components/schemas/CompactionSettings-Input" }, { "type": "null" } ], "description": "The compaction settings configuration used for compaction." }, "context_window_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Context Window Limit", "description": "The context window limit used by the agent." }, "reasoning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Reasoning", "description": "Deprecated: Use `model` field to configure reasoning instead. Whether to enable reasoning for this agent.", "deprecated": true }, "llm_config": { "anyOf": [ { "$ref": "#/components/schemas/LLMConfig" }, { "type": "null" } ], "description": "Deprecated: Use `model` field instead. The LLM configuration used by the agent.", "deprecated": true }, "embedding_config": { "anyOf": [ { "$ref": "#/components/schemas/EmbeddingConfig" }, { "type": "null" } ], "description": "The embedding configuration used by the agent." }, "parallel_tool_calls": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Parallel Tool Calls", "description": "Deprecated: Use `model_settings` to configure parallel tool calls instead. If set to True, enables parallel tool calling.", "deprecated": true }, "response_format": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/TextResponseFormat" }, { "$ref": "#/components/schemas/JsonSchemaResponseFormat" }, { "$ref": "#/components/schemas/JsonObjectResponseFormat" } ], "discriminator": { "propertyName": "type", "mapping": { "json_object": "#/components/schemas/JsonObjectResponseFormat", "json_schema": "#/components/schemas/JsonSchemaResponseFormat", "text": "#/components/schemas/TextResponseFormat" } } }, { "type": "null" } ], "title": "Response Format", "description": "Deprecated: Use `model_settings` field to configure response format instead. The response format for the agent.", "deprecated": true }, "max_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Tokens", "description": "Deprecated: Use `model` field to configure max output tokens instead. The maximum number of tokens to generate, including reasoning step.", "deprecated": true }, "enable_sleeptime": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Sleeptime", "description": "If set to True, memory management will move to a background agent thread." }, "last_run_completion": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Run Completion", "description": "The timestamp when the agent last completed a run." }, "last_run_duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Run Duration Ms", "description": "The duration in milliseconds of the agent's last run." }, "last_stop_reason": { "anyOf": [ { "$ref": "#/components/schemas/StopReasonType" }, { "type": "null" } ], "description": "The stop reason from the agent's last run." }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone", "description": "The timezone of the agent (IANA format)." }, "max_files_open": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Files Open", "description": "Maximum number of files that can be open at once for this agent. Setting this too high may exceed the context window, which will break the agent." }, "per_file_view_window_char_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Per File View Window Char Limit", "description": "The per-file view window character limit for this agent. Setting this too high may exceed the context window, which will break the agent." }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Hidden", "description": "If set to True, the agent will be hidden." } }, "type": "object" }