Skip to content
Proud to collaborate with Microsoft for Startups

agents.agent-config.update ​

Update fields on an existing agent configuration

Update an existing AgentConfig row.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-agents
Version1.0

Triggers ​

SourceEndpoint / EventDescription
APIPATCH /api/agents/configs/{config_uuid}Update an existing agent configuration

Input Schema ​

FieldTypeRequiredDefaultDescription
agent_config_uuidstringYes—Agent configuration UUID to update.
organization_uuidstringYes—Organization context UUID supplied by the workflow runtime.
namestringNo—Human-readable agent configuration name.
descriptionstringNo—Short human-readable summary of the agent's job.
system_promptstringNo—Instruction prompt supplied to the agent at session launch.
ai_provider_config_uuidstringNo—Optional enabled AI provider profile UUID. Discover valid profile/model pairs with data.ai-provider.list(enabled_only=true); each row's default_model is the model_name accepted for that profile. Omit to use the organization's default enabled profile.
model_profilestringNo—Name of an enabled AI provider profile to rebind this config to (the stable handle; equivalent to passing that row's ai_provider_config_uuid).
model_connection_uuidstringNo—Optional AI-provider connection UUID to switch this config to. Descriptive, budget, memory, runner, and tag updates reuse the stored connection when omitted.
model_namestringNo—Optional model name override. Must match the default_model shown for the selected enabled AI provider profile in data.ai-provider.list.
max_stepsintegerNo—Maximum number of reasoning/tool-use steps allowed per session.
max_tokens_per_stepintegerNo—Maximum model output token budget allowed for each step.
budget_usdfloatNo—Optional per-session cost ceiling in USD for this agent configuration.
memory_enabledbooleanNo—Whether sessions launched from this config may retrieve agent memory.
memory_write_enabledbooleanNo—Whether finished sessions from this config are distilled into memory. Separate from memory_enabled, which governs reading: a bad recall wastes prompt tokens, a bad writer permanently pollutes the pool every later recall draws from. Defaults off.
memory_strategystringNo—Memory retrieval strategy when memory_enabled is true. Allowed values: last_k (most recent), importance (highest-scored), pack (ranked against the session's task and fitted to a token budget).
memory_top_kintegerNo—Maximum number of memory records to retrieve when memory is enabled; normally 5-30.
runner_group_uuidstringNo—Optional agent-eligible runner group UUID. Omit to leave runner selection to session launch defaults.
runner_imagestringNo—Optional runner container image override for sessions launched from this config.
runtime_profilestringNo—Reviewed runtime behavior. workspace-probe-v1 is the safe default; software-development-v1 is accepted only by a cloudless DevKit group when organization code execution policy permits it.
tagsdictNo—Optional JSON object of caller-defined tags stored with the agent configuration.

Output Schema ​

FieldTypeRequiredDefaultDescription
agent_config_uuidjsonNo——
errorstringNo——
error_typestringNo——
failed_atstringNo——
failed_at_statestringNo——
failed_layerjsonNo——
failed_stepstringNo——
failure_reasonstringNo——
updatedjsonNo——
organization_uuidjsonNo——
namejsonNo——
descriptionjsonNo——
system_promptjsonNo——
ai_provider_config_uuidjsonNo——
model_profilejsonNo——
model_overridejsonNo——
model_connection_uuidjsonNo——
model_namejsonNo——
max_stepsjsonNo——
max_tokens_per_stepjsonNo——
budget_usdjsonNo——
memory_enabledjsonNo——
memory_write_enabledjsonNo——
memory_strategyjsonNo——
memory_top_kjsonNo——
runner_group_uuidjsonNo——
runner_imagejsonNo——
runtime_profilejsonNo——
tagsjsonNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—run—
runNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedrunrun—
runcompletecompleted—
* (any state)failfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
updatedSUCCESSAgent configuration updatedagent_config_uuid, updated, organization_uuid
failedFAILUREAgent configuration updated failedfailure_reason, error, error_type, failed_at_state, failed_step, failed_layer

Business Errors ​

CodeMessage Template
AGENTS_ORGANIZATION_CONTEXT_INVALIDAuthenticated organization context is missing or does not match the workflow input
AGENTS_CONFIG_NOT_FOUNDAgent configuration {agent_config_uuid} was not found in the organization
AGENTS_SKILL_NOT_FOUNDAgent skill {skill_uuid} was not found in the organization
AGENTS_MCP_SERVER_NOT_FOUNDMCP server {mcp_server_uuid} was not found in the organization
AGENTS_RUNNER_GROUP_NOT_FOUNDRunner group {runner_group_uuid} was not found in the organization
AGENTS_VALIDATION_FAILEDWorkflow input or domain state failed validation:
AGENTS_CONFLICTConflicting agent domain state:

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "agents.agent-config.update",
  "initial_data": {
    "agent_config_uuid": "value",
    "organization_uuid": "value"
  }
}