Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-132885152.8 KB
agent

Update an agent

Update an existing agent.

put/agent/identities/{uid}

Path parameters

uidstring required

The unique identifier of the agent

Request body

namestring

The new name for the agent

descriptionstring nullable

Replacement description. Omit or pass null to leave unchanged, or use an empty value to clear.

promptstring nullable

Replacement prompt. Omit or pass null to leave unchanged, or use an empty value to clear.

environment_idstring nullable

Replacement default cloud environment ID. Omit or pass null to leave unchanged, or pass an empty string to clear.

skillsstring[] nullable

Replacement list of skill specs. Omit to leave unchanged, pass an empty array to clear, or pass a non-empty array to replace.

base_modelstring nullable

Replacement base model. Omit or pass null to leave unchanged, or pass an empty string to clear.

base_harnessstring nullable

Replacement default harness. Omit or pass null to leave unchanged, or pass an empty string to clear.

Response

Agent updated successfully

uidstring required

Unique identifier for the agent

namestring required

Name of the agent

descriptionstring nullable

Optional description of the agent

promptstring nullable

Optional base prompt for this agent

environment_idstring

Default cloud environment ID for runs executed by this agent. The precedence order for environment resolution is:

  1. The environment specified on the run itself
  2. The agent's default environment
  3. An empty environment
availableboolean required

Whether this agent is within the team's plan limit and can be used for runs

created_atstring date-time required

When the agent was created (RFC3339)

updated_atstring date-time required

When the agent was last updated (RFC3339)

skillsstring[] required

Ordered list of normalized skill specs associated with this agent. Always present; empty when no skills are attached.

base_modelstring

Base model for runs executed by this agent. The precedence order for model resolution is:

  1. The model specified on the run itself
  2. The agent's base model
  3. The team's default model
base_harnessstring

Default harness for runs executed by this agent. The precedence order for harness resolution is:

  1. The harness specified on the run itself
  2. The agent's base harness
  3. Oz